@appquality/unguess-design-system 3.0.7-alpha → 3.0.9-alpha

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 ADDED
@@ -0,0 +1,73 @@
1
+ # UNGUESS Design System
2
+
3
+ [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
4
+
5
+ ## Used by
6
+
7
+ - [Unguess platform](https://app.unguess.io/)
8
+
9
+ ## Tech stack
10
+
11
+ Building components
12
+
13
+ - ðŸŠī [Zendesk Garden](https://garden.zendesk.com/) as base design system
14
+ - ⚛ïļ [React](https://reactjs.org/) declarative component-centric UI
15
+ - 📚 [Storybook](https://storybook.js.org) for UI component development and [auto-generated docs](https://medium.com/storybookjs/storybook-docs-sneak-peak-5be78445094a)
16
+ - ðŸ‘Đ‍ðŸŽĪ [Styled Components](https://styled-components.com/) for component-scoped styling
17
+
18
+ Maintaining the system
19
+
20
+ - ðŸ“Ķ [Yarn](https://yarnpkg.com/) for package management
21
+ - ðŸ“Ķ [NPM](https://www.npmjs.com/) for distribution
22
+ - ✅ [Chromatic](https://www.chromatic.com/) to prevent UI bugs in components (by Storybook maintainers)
23
+
24
+ ## Why
25
+
26
+ The Unguess design system codifies existing UI components into a central, well-maintained repository. It is built to address having to paste the same components into multiple projects again and again. This simplifies building UI's with Storybook's design patterns.
27
+
28
+ ## Install
29
+
30
+ ```bash
31
+ yarn
32
+ ```
33
+
34
+ ## Global Styles
35
+
36
+ Components within the design system assume that a set of global styles have been configured. Depending upon the needs of the application, this can be done several ways:
37
+
38
+ #### Option 1: Render the `GlobalStyle` component
39
+
40
+ Useful when you don't need any custom `body` styling in the application, typically this would be placed in a layout component that wraps all pages, or a top-level `App` component.
41
+
42
+ ```javascript
43
+ import { global } from '@storybook/design-system';
44
+ const { GlobalStyle } = global;
45
+ ```
46
+
47
+ ```javascript
48
+ /* Render the global styles once per page */
49
+ <GlobalStyle />
50
+ ```
51
+
52
+ #### Option 2: Use the `bodyStyles` to apply styling
53
+
54
+ Useful when you want build upon the shared global styling.
55
+
56
+ ```javascript
57
+ import { Global, css } from '@storybook/theming';
58
+ import { global } from '@storybook/design-system';
59
+ const { bodyStyles } = global;
60
+
61
+ const customGlobalStyle = css`
62
+ body {
63
+ ${bodyStyles}// Custom body styling for the app
64
+ }
65
+ `;
66
+
67
+ const CustomGlobalStyle = () => <Global styles={customGlobalStyle} />;
68
+ ```
69
+
70
+ ```javascript
71
+ /* Render the global styles once per page */
72
+ <CustomGlobalStyle />
73
+ ```
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import { ButtonArgs } from "./_types";
3
2
  export declare const Default: {
4
3
  decorators?: import("@storybook/types").DecoratorFunction<import("@storybook/react/dist/types-0a347bb9").R, {
@@ -76,7 +75,7 @@ export declare const Default: {
76
75
  results?: number | undefined;
77
76
  security?: string | undefined;
78
77
  unselectable?: "on" | "off" | undefined;
79
- inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
78
+ inputMode?: "decimal" | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | undefined;
80
79
  is?: string | undefined;
81
80
  'aria-activedescendant'?: string | undefined;
82
81
  'aria-atomic'?: (boolean | "true" | "false") | undefined;
@@ -380,7 +379,7 @@ export declare const Basic: {
380
379
  results?: number | undefined;
381
380
  security?: string | undefined;
382
381
  unselectable?: "on" | "off" | undefined;
383
- inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
382
+ inputMode?: "decimal" | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | undefined;
384
383
  is?: string | undefined;
385
384
  'aria-activedescendant'?: string | undefined;
386
385
  'aria-atomic'?: (boolean | "true" | "false") | undefined;
@@ -684,7 +683,7 @@ export declare const Primary: {
684
683
  results?: number | undefined;
685
684
  security?: string | undefined;
686
685
  unselectable?: "on" | "off" | undefined;
687
- inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
686
+ inputMode?: "decimal" | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | undefined;
688
687
  is?: string | undefined;
689
688
  'aria-activedescendant'?: string | undefined;
690
689
  'aria-atomic'?: (boolean | "true" | "false") | undefined;
@@ -988,7 +987,7 @@ export declare const WithIcon: {
988
987
  results?: number | undefined;
989
988
  security?: string | undefined;
990
989
  unselectable?: "on" | "off" | undefined;
991
- inputMode?: "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | undefined;
990
+ inputMode?: "decimal" | "none" | "search" | "text" | "tel" | "url" | "email" | "numeric" | undefined;
992
991
  is?: string | undefined;
993
992
  'aria-activedescendant'?: string | undefined;
994
993
  'aria-atomic'?: (boolean | "true" | "false") | undefined;
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import { DropdownArgs, SelectArgs } from "./_types";
3
2
  import { MenuArgs } from "../menu/_types";
4
3
  interface IItem {
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import { EditorArgs } from "./_types";
3
2
  interface EditorStoryArgs extends EditorArgs {
4
3
  children?: any;
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  import { TooltipArgs } from "./_types";
3
2
  export declare const Default: import("@storybook/types").AnnotatedStoryFn<import("@storybook/react/dist/types-0a347bb9").R, TooltipArgs>;
4
3
  declare const _default: import("@storybook/types").ComponentAnnotations<import("@storybook/react/dist/types-0a347bb9").R, {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appquality/unguess-design-system",
3
- "version": "3.0.7-alpha",
3
+ "version": "3.0.9-alpha",
4
4
  "description": "",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
@@ -9,7 +9,9 @@
9
9
  "storybook": "storybook dev -p 6006",
10
10
  "build-storybook": "storybook build",
11
11
  "build": "yarn run clean && rollup -c",
12
- "clean": "rimraf build"
12
+ "clean": "rimraf build",
13
+ "release": "npx auto shipit --base-branch=master",
14
+ "type:check": "tsc"
13
15
  },
14
16
  "repository": {
15
17
  "type": "git",
@@ -32,6 +34,7 @@
32
34
  "@nivo/sunburst": "^0.80.0",
33
35
  "@nivo/tooltip": "^0.80.0",
34
36
  "@nivo/waffle": "^0.80.0",
37
+ "react-spring": "^9.7.1",
35
38
  "@tiptap/extension-bubble-menu": "^2.0.0-beta.61",
36
39
  "@tiptap/extension-character-count": "^2.0.0-beta.31",
37
40
  "@tiptap/extension-placeholder": "^2.0.0-beta.53",
@@ -57,7 +60,6 @@
57
60
  "@zendeskgarden/react-tooltips": "^8.49.0",
58
61
  "@zendeskgarden/react-typography": "^8.49.0",
59
62
  "react-slick": "^0.29.0",
60
- "react-spring": "^9.4.4",
61
63
  "react-window": "^1.8.6",
62
64
  "ua-parser-js": "^1.0.2"
63
65
  },
@@ -89,8 +91,8 @@
89
91
  "formik": "^2.2.9",
90
92
  "prop-types": "^15.8.1",
91
93
  "react": "^18.2.0",
92
- "react-scripts": "^5.0.1",
93
94
  "react-dom": "^18.2.0",
95
+ "react-scripts": "^5.0.1",
94
96
  "rimraf": "3.0.2",
95
97
  "rollup": "~2.66",
96
98
  "rollup-plugin-typescript2": "^0.34.1",
package/.babelrc.json DELETED
@@ -1,16 +0,0 @@
1
- {
2
- "sourceType": "unambiguous",
3
- "presets": [
4
- [
5
- "@babel/preset-env",
6
- {
7
- "targets": {
8
- "chrome": 100
9
- }
10
- }
11
- ],
12
- "@babel/preset-typescript",
13
- "@babel/preset-react"
14
- ],
15
- "plugins": []
16
- }