@hexure/ui 1.8.17 → 1.9.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 +6 -1
- package/dist/cjs/index.js +201 -98
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/types/Theme.d.ts +6 -0
- package/dist/cjs/types/components/Input/Input.d.ts +4 -0
- package/dist/cjs/types/components/Modal/Modal.d.ts +3 -1
- package/dist/esm/index.js +201 -98
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/types/Theme.d.ts +6 -0
- package/dist/esm/types/components/Input/Input.d.ts +4 -0
- package/dist/esm/types/components/Modal/Modal.d.ts +3 -1
- package/dist/index.d.ts +7 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,6 +15,11 @@ InsTech UI is the source repository for the @hexure/ui npm package. This library
|
|
|
15
15
|
`npm run rollup` to run rollup and generate a dist folder
|
|
16
16
|
`npm run storybook` to run storybook server and see components on storybook.
|
|
17
17
|
`npm run test` to run all test cases.
|
|
18
|
+
5. Optional: Applying a custom theme:
|
|
19
|
+
1. Import the `ThemeProvider` from styled-components: `import { ThemeProvider } from 'styled-components'`
|
|
20
|
+
2. Wrap your top level application with the ThemeProvider: `<ThemeProvider><YourApp /></ThemeProvider>`
|
|
21
|
+
3. Define your custom theme on the provider: `<ThemeProvider theme={{ PRIMARY_COLOR: { Hex: 'Blue', Rgb: '10,10,10' } }}><YourApp /></ThemeProvider>`
|
|
22
|
+
4. As of v1.9.0 the only theme option is `PRIMARY_COLOR` and it must be an object with `Hex` and `Rbg` values.
|
|
18
23
|
|
|
19
24
|
|
|
20
25
|
# Contribute
|
|
@@ -81,5 +86,5 @@ You should release a new version of this package immediately after a Pull Reques
|
|
|
81
86
|
12. Go to the Azure DevOps repo and add a new Tag
|
|
82
87
|
- Tag Name: v1.x.x
|
|
83
88
|
- Description: Add details around what was added/changed
|
|
84
|
-
|
|
89
|
+
|
|
85
90
|
|