@yummacss/api 1.4.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -55
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,62 +15,9 @@ Yumma CSS API provides access to Yumma CSS utilities through Javascript function
|
|
|
15
15
|
npm i @yummacss/api
|
|
16
16
|
```
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## Documentation
|
|
19
19
|
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
```ts
|
|
23
|
-
import { getAllUtils } from "@yummacss/api";
|
|
24
|
-
|
|
25
|
-
const all = getAllUtils();
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
Get only background utilities:
|
|
29
|
-
|
|
30
|
-
```ts
|
|
31
|
-
import { getBackgroundUtils } from "@yummacss/api";
|
|
32
|
-
|
|
33
|
-
const backgrounds = getBackgroundUtils();
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
Access a specific utility from a category:
|
|
37
|
-
|
|
38
|
-
```ts
|
|
39
|
-
import { getBoxModelUtils } from "@yummacss/api";
|
|
40
|
-
|
|
41
|
-
const boxModel = getBoxModelUtils();
|
|
42
|
-
const margin = boxModel["margin"];
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## Available functions
|
|
46
|
-
|
|
47
|
-
```ts
|
|
48
|
-
import {
|
|
49
|
-
getAllUtils,
|
|
50
|
-
getBackgroundUtils,
|
|
51
|
-
getBorderUtils,
|
|
52
|
-
getBoxModelUtils,
|
|
53
|
-
getColorUtils,
|
|
54
|
-
getEffectUtils,
|
|
55
|
-
getFlexboxUtils,
|
|
56
|
-
getFontUtils,
|
|
57
|
-
getGridUtils,
|
|
58
|
-
getInteractivityUtils,
|
|
59
|
-
getOutlineUtils,
|
|
60
|
-
getPositioningUtils,
|
|
61
|
-
getSvgUtils,
|
|
62
|
-
getTableUtils,
|
|
63
|
-
getTextUtils,
|
|
64
|
-
getTransformUtils,
|
|
65
|
-
} from "@yummacss/api";
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
## Using Typescript
|
|
69
|
-
|
|
70
|
-
```ts
|
|
71
|
-
import type { Utilities, Colors } from "@yummacss/api"; // returns a map of utilities
|
|
72
|
-
import type { Color, Utility } from "@yummacss/api"; // returns a single object
|
|
73
|
-
```
|
|
20
|
+
Head over to the [Yumma CSS docs](https://www.yummacss.com/docs/dev-api) for full API to learn more.
|
|
74
21
|
|
|
75
22
|
## Built with
|
|
76
23
|
|