@jobber/design 0.29.0 → 0.29.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/CHANGELOG.md +8 -0
- package/README.stories.mdx +7 -81
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -8,6 +8,14 @@ menu: Changelog
|
|
|
8
8
|
All notable changes to this project will be documented in this file.
|
|
9
9
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
10
10
|
|
|
11
|
+
## [0.29.1](https://github.com/GetJobber/atlantis/compare/@jobber/design@0.29.0...@jobber/design@0.29.1) (2023-02-24)
|
|
12
|
+
|
|
13
|
+
**Note:** Version bump only for package @jobber/design
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
|
|
11
19
|
# [0.29.0](https://github.com/GetJobber/atlantis/compare/@jobber/design@0.28.6...@jobber/design@0.29.0) (2023-02-23)
|
|
12
20
|
|
|
13
21
|
|
package/README.stories.mdx
CHANGED
|
@@ -1,83 +1,9 @@
|
|
|
1
|
-
import { Meta } from "@storybook/addon-docs";
|
|
1
|
+
import { Description, Meta } from "@storybook/addon-docs";
|
|
2
|
+
import Readme from "./README.mdx";
|
|
2
3
|
|
|
3
|
-
<Meta
|
|
4
|
+
<Meta
|
|
5
|
+
title="Packages/Design"
|
|
6
|
+
parameters={{ previewTabs: { canvas: { hidden: true } } }}
|
|
7
|
+
/>
|
|
4
8
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Foundational colors and rhythm for the Jobber Atlantis Design System
|
|
8
|
-
|
|
9
|
-
## Installation
|
|
10
|
-
|
|
11
|
-
```sh
|
|
12
|
-
npm install @jobber/design
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Usage
|
|
16
|
-
|
|
17
|
-
`@jobber/design` ships `foundation.css`. It also provides utilities for getting
|
|
18
|
-
icons svg path.
|
|
19
|
-
|
|
20
|
-
### CSS
|
|
21
|
-
|
|
22
|
-
#### Foundation
|
|
23
|
-
|
|
24
|
-
Import the `@jobber/design` stylesheet into your own css
|
|
25
|
-
|
|
26
|
-
```css
|
|
27
|
-
@import "~@jobber/design/foundation.css";
|
|
28
|
-
|
|
29
|
-
.myLabel {
|
|
30
|
-
color: var(--color-blue);
|
|
31
|
-
padding: var(--space-base);
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
For web, if `design/foundation.css` is already included you do not need to
|
|
36
|
-
import it for every css file. For React Native, you need to import
|
|
37
|
-
`design/foundation.css` in every css files that needs it.
|
|
38
|
-
|
|
39
|
-
#### icons
|
|
40
|
-
|
|
41
|
-
Import the `getIcon` utility into your JavaScript/Typescript file
|
|
42
|
-
|
|
43
|
-
```tsx
|
|
44
|
-
import { getIcon } from "@jobber/design";
|
|
45
|
-
|
|
46
|
-
const { svgClassNames, paths, viewBox } = getIcon({
|
|
47
|
-
name: "dashboard",
|
|
48
|
-
color: "green",
|
|
49
|
-
size: "large",
|
|
50
|
-
});
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
You can also get the type definitions for `IconNames`, `IconColorNames`, and
|
|
54
|
-
`IconSizes` from `@jobber/design`
|
|
55
|
-
|
|
56
|
-
```tsx
|
|
57
|
-
import type { IconNames, IconColorNames, IconSizes } from "@jobber/design";
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
If you need the actual css files for icons, you can import them from
|
|
61
|
-
`@jobber/design/icons`. You may not need these files for the web but they might
|
|
62
|
-
be required for React Native
|
|
63
|
-
|
|
64
|
-
```css
|
|
65
|
-
@import "@jobber/design/foundation.css";
|
|
66
|
-
@import "@jobber/design/icons/Icon";
|
|
67
|
-
@import "@jobber/design/icons/Sizes";
|
|
68
|
-
@import "@jobber/design/icons/Colors";
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### PostCSS
|
|
72
|
-
|
|
73
|
-
Inject `@jobber/foundation` into your css with `postcss`
|
|
74
|
-
|
|
75
|
-
```js
|
|
76
|
-
module.exports = {
|
|
77
|
-
plugins: [
|
|
78
|
-
require("postcss-preset-env")({
|
|
79
|
-
importFrom: ["@jobber/design"],
|
|
80
|
-
}),
|
|
81
|
-
],
|
|
82
|
-
};
|
|
83
|
-
```
|
|
9
|
+
<Readme />
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jobber/design",
|
|
3
|
-
"version": "0.29.
|
|
3
|
+
"version": "0.29.1",
|
|
4
4
|
"description": "Design foundation for the Jobber Atlantis Design System",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -56,5 +56,5 @@
|
|
|
56
56
|
"typed-css-modules": "^0.7.0",
|
|
57
57
|
"typescript": "^3.8.3"
|
|
58
58
|
},
|
|
59
|
-
"gitHead": "
|
|
59
|
+
"gitHead": "1721cceed6e6f141beb75cc4a5c79fa519e9bbc5"
|
|
60
60
|
}
|