Skip to content

Commit

Permalink
Correct the documentation of CSS usage
Browse files Browse the repository at this point in the history
  • Loading branch information
adamkudrna committed Mar 6, 2024
1 parent 3305eec commit 654e775
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 21 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,13 @@ To install React UI in your app:
/>
```

3. Load the default theme and the CSS foundation layer:
3. Load React UI CSS in your app:

<!-- eslint-env browser -->
<!-- eslint-disable import/no-unresolved -->

```js
import '@react-ui-org/react-ui/src/lib/theme.scss';
import '@react-ui-org/react-ui/src/lib/foundation.scss';
import '@react-ui-org/react-ui/dist/react-ui.css';
```

<!-- eslint-env browser -->
Expand Down Expand Up @@ -101,8 +100,11 @@ module.exports = (env, argv) => ({
alias: {
// Allow to run react-ui in development mode for easier development.
'@react-ui-org/react-ui$': argv.mode === 'production'
? '@react-ui-org/react-ui/dist/lib.js'
: '@react-ui-org/react-ui/dist/lib.development.js',
? '@react-ui-org/react-ui/dist/react-ui.js'
: '@react-ui-org/react-ui/dist/react-ui.development.js',
'@react-ui-org/react-ui/dist/react-ui.css': modeArgument === 'production'
? '@react-ui-org/react-ui/dist/react-ui.css'
: '@react-ui-org/react-ui/dist/react-ui.development.css',
},
},
});
Expand Down
22 changes: 7 additions & 15 deletions src/docs/getting-started/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,35 +29,30 @@ performance).
## CSS

React UI honors [ITCSS][itcss] principles to make sure that its CSS code base
will work and perform well even in large scale. There are three global CSS
layers:
will work and perform well even in large scale. There are four CSS layers:

1. **Theme:** a collection of hundreds of CSS custom properties that define the
look of your app. See [Theming][theming] for more.
2. **Foundation:** mandatory ground-zero CSS for React UI components. Includes
global resets and fixes rendering inconsistencies across browsers with
`normalize.css`. (Not to be confused with the Foundation CSS framework.)
3. **CSS helpers:** tiny CSS classes that can handle details like
3. **Components:** React UI components' styles. Components utilize [CSS modules]
to avoid class name conflicts and to keep the class names scoped.
4. **CSS helpers:** tiny CSS classes that can handle details like
[typography][typography], [spacing][spacing], [colors][colors], etc. Class
name notation is [inspired by Bootstrap][bootstrap-utilities], so if you are
familiar with Bootstrap, you will feel at home here.

All layers are written in Sass and compiled to CSS. You can import them in a
**ready-to-use CSS bundle** like this:
All layers are written in Sass and compiled to CSS. You can import them all in
a **ready-to-use CSS bundle** like this:

```js
import '@react-ui-org/react-ui/dist/react-ui.css';
```

### Sass

Alternatively, you can import the Sass source files directly:

```js
import '@react-ui-org/react-ui/src/theme.scss';
import '@react-ui-org/react-ui/src/foundation.scss';
import '@react-ui-org/react-ui/src/helpers.scss';
```
👉 As of now, we don't provide a way to import the Sass files directly.

## Components

Expand All @@ -69,9 +64,6 @@ import { Button } from '@react-ui-org/react-ui';
<Button label="My Button" />
```

👉 Thanks to [CSS modules], React UI components have their styles bundled
together with the component code.

### Controlled vs. Uncontrolled

While you may find out some components are working for you as uncontrolled, we
Expand Down
3 changes: 2 additions & 1 deletion src/index.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
// Global definitions
// These need to be imported here to be placed in the distribution CSS file
// These need to be imported here to be placed in the distribution CSS file.
// Component styles are imported in the component files themselves.
import './theme.scss';
import './foundation.scss';
import './helpers.scss';
Expand Down

0 comments on commit 654e775

Please sign in to comment.