Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit 61f0391

Browse files
authored
Merge pull request #79 from geotrev/develop
[Version 2.2.0] Updated docs, new utilities
2 parents 7170735 + 60c4f91 commit 61f0391

File tree

96 files changed

+2847
-2605
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+2847
-2605
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ For the most control over your CSS, it's highly recommended to integrate the SCS
5555

5656
You can then easily customize `_config.scss` with your intended brand attributes. This is where you'd also define a scope to isolate Undernet styles.
5757

58-
For more details on the config, check out the [Getting Started](https://undernet.io/docs/getting-started) page.
58+
For more details on customizing branding, check out the [Branding](https://undernet.io/docs/overview/branding) page.
5959

6060
### NPM / JS modules
6161

@@ -65,7 +65,7 @@ Another option is to use the npm package and borrow the modules you need. This i
6565
$ npm install --save-dev undernet
6666
```
6767

68-
Check out the [docs](https://undernet.io/docs/overview) to see the necessary DOM structure for a given component.
68+
Check out the [documentation](https://undernet.io/docs/overview/javascript) to see the necessary DOM structure for a given component.
6969

7070
Then require or import the dependency in your js, or add it to a script tag in your main layout (see the **Easy setup** method above for script usage).
7171

@@ -76,13 +76,13 @@ import Undernet from "undernet"
7676
Undernet.start()
7777

7878
// or only use a single component, e.g. the Modal:
79-
// NOTE: if you use Undernet.start(), you're effectively doing nothing with this method call
79+
// NOTE: if you use Undernet.start(), you're effectively doing nothing with this property call
8080
Undernet.Modals.start()
8181
```
8282

8383
#### React
8484

85-
Undernet fully supports use in React. You simply need to call the `.start()` method in `componentDidMount()`, and then `.stop()` in `componentWillUnmount()` (to prevent unnecessary event listeners when the components are no longer visible):
85+
Undernet fully supports use in React. You simply need to call the `.start()` property in `componentDidMount()`, and then `.stop()` in `componentWillUnmount()` (to prevent unnecessary event listeners when the components are no longer visible):
8686

8787
```js
8888
export default class SomeComponent extends React.Component {
@@ -167,11 +167,10 @@ Then globally install `sass` and `rollup`:
167167

168168
```shell
169169
$ gem install sass
170-
$ npm install -g rollup
171170
$ npm run build:development
172171
```
173172

174-
From there, everything should build correctly: the framework scss and js will be prettified by `prettier` and distributions of js and css will be output using `babel-cli`, `rollup`, `sass`, and a few macOS specific commands for zipping/prepping files for release. The output typically takes 5-10 seconds at most.
173+
From there, everything should build correctly: the framework scss and js will be prettified by `prettier` and distributions of js and css will be output using `@babel`, `rollup`, `sass`, and a few macOS specific commands for zipping/prepping files for release. The output typically takes 5-10 seconds at most.
175174

176175
### Rebuild assets on the fly
177176

config/rollup.config.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ module.exports = {
2121
resolve(),
2222
babel({
2323
exclude: "node_modules/**",
24-
plugins: ["@babel/external-helpers"],
2524
}),
2625
],
2726
}

dist/undernet.bundle.js

Lines changed: 57 additions & 23 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/undernet.bundle.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)