@antscorp/antsomi-ui 1.1.0 → 1.1.2

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.
Files changed (2) hide show
  1. package/README.md +78 -0
  2. package/package.json +8 -3
package/README.md ADDED
@@ -0,0 +1,78 @@
1
+ <p align="center">
2
+ <a href="https://ant.design">
3
+ <img width="200" src="https://st-home.antsomi.com/wp-content/uploads/2020/04/Antsomi-CDP-365-logo.png">
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center">Antsomi UI</h1>
8
+
9
+ <div align="center">
10
+
11
+ An enterprise-class UI design language and React UI library.
12
+
13
+ [![NPM version][npm-image]][npm-url] [![NPM downloads][download-image]][download-url] [![][bundlephobia-image]][bundlephobia-url]
14
+
15
+ [npm-image]: https://img.shields.io/npm/v/@antscorp/antsomi-ui.svg?style=flat-square
16
+ [npm-url]: https://www.npmjs.com/package/@antscorp/antsomi-ui
17
+ [github-action-image]: https://github.com/ant-design/ant-design/workflows/%E2%9C%85%20test/badge.svg
18
+ [github-action-url]: https://github.com/ant-design/ant-design/actions?query=workflow%3A%22%E2%9C%85+test%22
19
+ [codecov-image]: https://img.shields.io/codecov/c/github/ant-design/ant-design/master.svg?style=flat-square
20
+ [codecov-url]: https://codecov.io/gh/ant-design/ant-design/branch/master
21
+ [download-image]: https://img.shields.io/npm/dm/@antscorp/antsomi-ui.svg?style=flat-square
22
+ [download-url]: https://npmjs.org/package/antd
23
+ [fossa-image]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fant-design%2Fant-design.svg?type=shield
24
+ [fossa-url]: https://app.fossa.io/projects/git%2Bgithub.com%2Fant-design%2Fant-design?ref=badge_shield
25
+ [help-wanted-image]: https://flat.badgen.net/github/label-issues/ant-design/ant-design/help%20wanted/open
26
+ [help-wanted-url]: https://github.com/ant-design/ant-design/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22
27
+ [twitter-image]: https://img.shields.io/twitter/follow/AntDesignUI.svg?label=Ant%20Design
28
+ [twitter-url]: https://twitter.com/AntDesignUI
29
+ [bundlesize-js-image]: https://img.badgesize.io/https:/unpkg.com/antd/dist/antd.min.js?label=antd.min.js&compression=gzip&style=flat-square
30
+ [unpkg-js-url]: https://unpkg.com/browse/antd/dist/antd.min.js
31
+ [bundlephobia-image]: https://badgen.net/bundlephobia/minzip/antd?style=flat-square
32
+ [bundlephobia-url]: https://bundlephobia.com/package/@antscorp/antsomi-ui
33
+ [issues-helper-image]: https://img.shields.io/badge/using-issues--helper-orange?style=flat-square
34
+ [issues-helper-url]: https://github.com/actions-cool/issues-helper
35
+ [renovate-image]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?style=flat-square
36
+ [renovate-dashboard-url]: https://github.com/ant-design/ant-design/issues/32498
37
+ [dumi-image]: https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square
38
+ [dumi-url]: https://github.com/umijs/dumi
39
+
40
+ </div>
41
+
42
+ [![](https://st-media-template.antsomi.com/upload/2023/03/22/9d157c08-5f33-4b60-a558-1da9dde42d61.png)](https://antsomi-docs.vercel.app/)
43
+
44
+ ## ✨ Features
45
+
46
+ - 🌈 Enterprise-class UI designed for web applications.
47
+ - 📦 A set of high-quality React components out of the box.
48
+ - 🛡 Written in TypeScript with predictable static types.
49
+ - ⚙️ Whole package of design resources and development tools.
50
+ - 🌍 Internationalization support for dozens of languages.
51
+ - 🎨 Powerful theme customization based on CSS-in-JS.
52
+
53
+ ## 📦 Install
54
+
55
+ ```bash
56
+ npm install @antscorp/antsomi-ui
57
+ ```
58
+
59
+ ```bash
60
+ yarn add @antscorp/antsomi-ui
61
+ ```
62
+
63
+ ## 🔨 Usage
64
+
65
+ ```jsx
66
+ import React from 'react';
67
+ import { Button } from '@antscorp/antsomi-ui';
68
+
69
+ const App = () => (
70
+ <>
71
+ <Button type="primary">Click me</Button>
72
+ </>
73
+ );
74
+ ```
75
+
76
+ ### TypeScript
77
+
78
+ `@antscorp/antsomi-ui` is written in TypeScript with complete definitions.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antscorp/antsomi-ui",
3
- "version": "1.1.0",
3
+ "version": "1.1.2",
4
4
  "description": "An enterprise-class UI design language and React UI library.",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -15,8 +15,10 @@
15
15
  "lint": "yarn run eslint src",
16
16
  "lint:fix": "yarn run eslint src --fix",
17
17
  "prepare": "husky install",
18
- "storybook": "start-storybook -p 6006",
19
- "build-storybook": "build-storybook"
18
+ "storybook": "start-storybook -p 6006 -s public",
19
+ "build-storybook": "build-storybook",
20
+ "serve-storybook": "serve storybook-static",
21
+ "version": "auto-changelog -p && git add CHANGELOG.md"
20
22
  },
21
23
  "husky": {
22
24
  "hooks": {
@@ -38,6 +40,8 @@
38
40
  "@babel/core": "^7.21.3",
39
41
  "@babel/preset-env": "^7.20.2",
40
42
  "@babel/preset-react": "^7.18.6",
43
+ "@commitlint/cli": "^17.5.0",
44
+ "@commitlint/config-conventional": "^17.4.4",
41
45
  "@emotion/react": "^11.10.6",
42
46
  "@rollup/plugin-commonjs": "^24.0.1",
43
47
  "@rollup/plugin-image": "^3.0.2",
@@ -61,6 +65,7 @@
61
65
  "@typescript-eslint/parser": "^5.55.0",
62
66
  "@vitejs/plugin-react": "^3.1.0",
63
67
  "antd": "^5.3.2",
68
+ "auto-changelog": "^2.4.0",
64
69
  "babel-loader": "^8.3.0",
65
70
  "css-loader": "^6.7.3",
66
71
  "eslint": "^8.36.0",