@clickhouse/click-ui 0.0.92 → 0.0.94
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 +5 -4
- package/dist/click-ui.es.js +5907 -5699
- package/dist/click-ui.umd.js +186 -186
- package/dist/components/Container/Container.d.ts +1 -1
- package/dist/components/GridContainer/GridContainer.d.ts +26 -0
- package/dist/components/Icon/types.d.ts +1 -1
- package/dist/components/Logos/AWSKinesis.d.ts +3 -0
- package/dist/components/Logos/Redpanda.d.ts +3 -0
- package/dist/components/Logos/Upstash.d.ts +3 -0
- package/dist/components/Logos/types.d.ts +1 -1
- package/dist/components/Pagination/Pagination.d.ts +12 -0
- package/dist/components/Panel/Panel.d.ts +2 -1
- package/dist/components/Typography/Text/Text.d.ts +2 -0
- package/dist/components/Typography/Title/Title.d.ts +2 -0
- package/dist/components/index.d.ts +2 -0
- package/dist/components/types.d.ts +3 -0
- package/dist/styles/types.d.ts +33 -0
- package/dist/styles/variables.classic.json.d.ts +12 -0
- package/dist/styles/variables.dark.json.d.ts +12 -0
- package/dist/styles/variables.json.d.ts +33 -0
- package/dist/styles/variables.light.json.d.ts +12 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
# Click UI
|
|
2
|
+
|
|
2
3
|
The home of the ClickHouse design system and component library. Click UI is in very early development and subject to change, we do not recommend using it for production purposes.
|
|
3
4
|
|
|
4
5
|
### Using Click UI in an external app
|
|
6
|
+
|
|
5
7
|
Click UI has been tested in NextJS, Gatsby, and Vite. If you run into problems using it in your app, please create an issue and our team will try to answer.
|
|
6
8
|
1. Navigate to your app's route and run
|
|
7
9
|
`npm i @clickhouse/click-ui`
|
|
@@ -9,8 +11,8 @@ Click UI has been tested in NextJS, Gatsby, and Vite. If you run into problems u
|
|
|
9
11
|
`yarn add @clickhouse/click-ui`
|
|
10
12
|
2. Make sure to wrap your application in the Click UI `ClickUIProvider`, without doing this, you may run into issues with styled-components. Once thats done, you'll be able to import the individual components that you want to use on each page. Here's an example an `App.tsx` in NextJS.
|
|
11
13
|
|
|
12
|
-
```
|
|
13
|
-
import {
|
|
14
|
+
```ts
|
|
15
|
+
import { ClickUIProvider, Text, ThemeName, Title, Switch } from '@clickhouse/click-ui'
|
|
14
16
|
|
|
15
17
|
function App() {
|
|
16
18
|
const [theme, setTheme] = useState<ThemeName>('dark')
|
|
@@ -32,9 +34,8 @@ function App() {
|
|
|
32
34
|
export default App
|
|
33
35
|
```
|
|
34
36
|
|
|
35
|
-
|
|
36
|
-
|
|
37
37
|
### To develop this library locally 🚀
|
|
38
|
+
|
|
38
39
|
1. Clone this repo, cd into the `click-ui` directory
|
|
39
40
|
2. To install dependencies, run `npm i`
|
|
40
41
|
3. To build the latest styles, run `npm run generate-tokens`
|