rustlanges-components 0.1.0

RustLangES components library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# RustLangES Design System styles

### Installation

> [!WARNING]
> Both deploys are pending and subject to change.

```bash
$ npm install @rustlanges/styles
```

or by cdn

```html
<link rel="stylesheet" href="https://styles.rustlang-es.org/bundled.css" />
```

## Usage

### Using tailwindcss

In your tailwindcss's styles file import `@rustlanges/styles`, or import just
the modules needed.


```css
/* For complete theme */
@import "@rustlanges/styles";

/* For modular theme */
@import "@rustlanges/styles/theme";
@import "@rustlanges/styles/breakpoints";
@import "@rustlanges/styles/components";
@import "@rustlanges/styles/utilities";

@import "@rustlanges/styles/components/text";
@import "@rustlanges/styles/utilities/shadow";
```

> [!NOTE]
> Importing `@rustlanges/styles` also import default theme from tailwindcss
> `tailwindcss/theme` and `tailwindcss/utilities` but don't reset styles.

### Using vite:

```js
// With tailwindcss installed
import "@rustlanges/styles";

// Without tailwindcss installed
import "@rustlanges/styles/bundled.css";
```

> [!NOTE]
> Just import component styles and some utilities classes defined in [safelist.txt](./safelist.txt).

## Project structure

```
.
├── components/
└── utilities/
```