Skip to content

Commit a6defa2

Browse files
committed
docs: update README file
1 parent 67d8303 commit a6defa2

File tree

1 file changed

+72
-26
lines changed

1 file changed

+72
-26
lines changed

README.md

+72-26
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const { AnyFrame, defineConfig } = __anyframe_core__
2727
const ui = new AnyFrame({
2828
tabSize: 2,
2929
showLayerModifier: false,
30-
layerOrder: ['base', 'theme', 'components', 'utilities'],
30+
layerOrder: ['theme', 'base', 'components', 'utilities'],
3131
// main tenoxui configuration, applied for all layers
3232
// see: https://github.com/tenoxui/tenoxui/tree/main/packages/%40tenoxui-static
3333
property: {},
@@ -40,8 +40,7 @@ const ui = new AnyFrame({
4040
// custom tenoxui configuration for different layers
4141
base: {},
4242
theme: {},
43-
components: {},
44-
utilities: {}
43+
components: {}
4544
})
4645
```
4746

@@ -55,7 +54,65 @@ const ui = new AnyFrame({
5554

5655
Note: You can checkout [TenoxUI Static Repository](https://github.com/tenoxui/tenoxui/tree/main/packages/%40tenoxui-static) for `property` `values`, `classes`, `breakpoints`, `aliases`, `reserveClass`, and `apply` options.
5756

58-
## Example
57+
## API
58+
59+
### `addLayer`, `removeLayer`, `setLayerOrder`
60+
61+
```typescript
62+
addLayer(layer: string) {}
63+
removeLayer(layer: string) {}
64+
setLayerOrder(layers: string[]) {}
65+
```
66+
67+
As its name, you can add, remove layer, and set new layer order. Example :
68+
69+
```javascript
70+
const ui = new AnyFrame()
71+
console.log(ui.layerOrder) // => theme, base, components, utilities
72+
73+
ui.addLayer('custom').addLayer('remove-later')
74+
console.log(ui.layerOrder) // => theme, base, components, utilities, custom, remove-later
75+
76+
//! Note that you can't remove 4 main layers; base theme, components, and utilities
77+
ui.removeLayer('remove-later')
78+
console.log(ui.layerOrder) // => theme, base, components, utilities, custom
79+
80+
ui.setLayerOrder(['utilities', 'theme', 'custom', 'components', 'base'])
81+
console.log(ui.layerOrder) // => utilities, theme, custom, components, base
82+
```
83+
84+
### `AnyFrame.addStyle`
85+
86+
```typescript
87+
addStyle(layer: string, config: TenoxUIConfig) {}
88+
```
89+
90+
Method to add custom config for exact layer. Example :
91+
92+
```javascript
93+
const ui = new AnyFrame({
94+
/* global config, accessible for all layers */
95+
property: {
96+
m: 'margin'
97+
}
98+
})
99+
100+
ui.addStyle('base', {
101+
/* only available for 'base' layer */
102+
property: {
103+
p: 'padding'
104+
},
105+
apply: {
106+
'*': 'm-0 p-0 [box-sizing]-border-box'
107+
}
108+
})
109+
110+
console.log(ui.layers.get('base'))
111+
```
112+
113+
### `AnyFrame.create`
114+
115+
Method that return the all styles, from every layers. Example :
59116

60117
```javascript
61118
const ui = new AnyFrame({
@@ -77,30 +134,19 @@ console.log(ui.create(['bg-red', 'm-10px', '[m,p]-2rem', 'bg-[rgb(0_255_0)]']))
77134

78135
Output:
79136

80-
```css
81-
@layer base, theme, components, utilities;
137+
```
138+
@layer theme, base, components, utilities;
82139
@layer base {
83-
*,
84-
*::before,
85-
*::after {
86-
margin: 0;
87-
padding: 0;
88-
box-sizing: border-box;
89-
}
140+
*, *::before, *::after { margin: 0; padding: 0; box-sizing: border-box }
90141
}
91142
@layer utilities {
92-
.bg-red {
93-
background: red;
94-
}
95-
.m-10px {
96-
margin: 10px;
97-
}
98-
.\[m\,p\]-2rem {
99-
margin: 2rem;
100-
padding: 2rem;
101-
}
102-
.bg-\[rgb\(0_255_0\)\] {
103-
background: rgb(0 255 0);
104-
}
143+
.bg-red { background: red }
144+
.m-10px { margin: 10px }
145+
.\[m\,p\]-2rem { margin: 2rem; padding: 2rem }
146+
.bg-\[rgb\(0_255_0\)\] { background: rgb(0 255 0) }
105147
}
106148
```
149+
150+
## License
151+
152+
MIT

0 commit comments

Comments
 (0)