https://github.com/ant-design/antd-token-previewer
https://github.com/ant-design/antd-token-previewer
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ant-design/antd-token-previewer
- Owner: ant-design
- License: mit
- Created: 2022-05-13T06:54:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-21T09:31:01.000Z (5 months ago)
- Last Synced: 2025-04-12T09:20:02.042Z (3 months ago)
- Language: TypeScript
- Homepage: https://ant-design.github.io/antd-token-previewer
- Size: 44.2 MB
- Stars: 77
- Watchers: 4
- Forks: 23
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# antd-token-previewer 🖥
Help you customize theme in Ant Design.
## Live Demo
https://ant-design.github.io/antd-token-previewer/
## Install
```
npm i antd-token-previewer
```
## Usage
Ref: https://ant-design.github.io/antd-token-previewer/editor
## API
### ThemeEditor
| Property | Description | Type | Default |
| ---------------- | ---------------------------------------- | ------------------------------ | ------- |
| theme | Controlled Theme object | `Theme` | - |
| onThemeChange | Callback when `theme` changed | `(theme: Theme) => void` | - |
| locale | Language used in ThemeEditor | `Locale` | `zhCN` |
| actions | Actions displayed on the right of header | `React.ReactNode` | - |
| advanced | Advance mode | `boolean` | - |
| onAdvancedChange | Callback when `advanced` change | `(advanced: booleaen) => void` | - |
| children | Preview area. | `ReactNode` | - |
### Theme
| Property | Description | Type |
| -------- | ------------------------------ | ------------- |
| name | Name of Theme | `string` |
| key | Used as `key` for ReactElement | `string` |
| config | Theme config of antd | `ThemeConfig` |
## Development
```
npm install
npm start
```
## License
antd-token-previewer is released under the MIT license.