@xylabs/sdk-react 3.0.18 → 3.0.20

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 (3) hide show
  1. package/README.md +40 -6
  2. package/package.json +30 -33
  3. package/dist/docs.json +0 -242006
package/README.md CHANGED
@@ -4,6 +4,9 @@
4
4
 
5
5
  [![main-build][]][main-build-link]
6
6
  [![npm-badge][]][npm-link]
7
+ [![npm-downloads-badge][]][npm-link]
8
+ [![jsdelivr-badge][]][jsdelivr-link]
9
+ [![npm-license-badge][]](LICENSE)
7
10
  [![codacy-badge][]][codacy-link]
8
11
  [![codeclimate-badge][]][codeclimate-link]
9
12
  [![snyk-badge][]][snyk-link]
@@ -21,7 +24,15 @@
21
24
 
22
25
  ## Description
23
26
 
24
- Common React code that is used throughtout XYO projects that use React.
27
+ Common React code that is used throughout XYO projects that use React.
28
+
29
+ Features:
30
+
31
+ - Mono-repo that publishes individual packages to npm
32
+ - Fully written in TypeScript
33
+ - Tree-shaking focused; include only what you need during bundling
34
+ - UI components built from the mui library
35
+ - Crypto utilities backed by the Ethers.js library
25
36
 
26
37
  ## Install
27
38
 
@@ -37,10 +48,24 @@ Using yarn:
37
48
  yarn add @xylabs/sdk-react
38
49
  ```
39
50
 
51
+ ## Documentation
52
+ [Developer Reference](https://xylabs.github.io/sdk-react)
53
+
54
+ [Storybook](https://xylabs.github.io/sdk-react/storybook)
55
+
40
56
  ## Scripts
41
57
 
42
- See [ts-scripts-yarn3](https://github.com/xylabs/ts-scripts-yarn3/blob/main/README.md) for
43
- list of shared scripts. The below scripts are custom scripts for this repo.
58
+ Using npm:
59
+
60
+ ```sh
61
+ npm xy --help
62
+ ```
63
+
64
+ Using yarn:
65
+
66
+ ```sh
67
+ yarn xy --help
68
+ ```
44
69
 
45
70
  ### Build (Storybook)
46
71
 
@@ -60,7 +85,10 @@ yarn start
60
85
 
61
86
  ## Maintainers
62
87
 
63
- - [Arie Trouw](https://github.com/arietrouw) [arietrouw.com](https://arietrouw.com)
88
+ - [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
89
+ - [Matt Jones](https://github.com/jonesmac)
90
+ - [Joel Carter](https://github.com/JoelBCarter)
91
+ - [Jordan Trouw](https://github.com/jordantrouw)
64
92
 
65
93
  ## License
66
94
 
@@ -79,10 +107,16 @@ See the [LICENSE](LICENSE) file for license details
79
107
  [npm-link]: https://www.npmjs.com/package/@xylabs/sdk-react
80
108
 
81
109
  [codacy-badge]: https://app.codacy.com/project/badge/Grade/c2a69d4530ed4b7da6ddb070169dd339
82
- [codacy-link]: https://www.codacy.com/gh/xylabs/sdk-react/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-react&utm_campaign=Badge_Grade
110
+ [codacy-link]: https://app.codacy.com/gh/xylabs/sdk-react
83
111
 
84
112
  [codeclimate-badge]: https://api.codeclimate.com/v1/badges/c461e0bc2b00c0b01ac0/maintainability
85
113
  [codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-react/maintainability
86
114
 
87
115
  [snyk-badge]: https://snyk.io/test/github/xylabs/sdk-react/badge.svg?targetFile=package.json
88
- [snyk-link]: https://snyk.io/test/github/xylabs/sdk-react?targetFile=package.json
116
+ [snyk-link]: https://snyk.io/test/github/xylabs/sdk-react?targetFile=package.json
117
+
118
+ [npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/react-shared
119
+ [npm-license-badge]: https://img.shields.io/npm/l/@xylabs/react-shared
120
+
121
+ [jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/react-shared/badge
122
+ [jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/react-shared
package/package.json CHANGED
@@ -13,38 +13,38 @@
13
13
  "packages/*"
14
14
  ],
15
15
  "dependencies": {
16
- "@xylabs/react-accordion": "~3.0.18",
17
- "@xylabs/react-appbar": "~3.0.18",
18
- "@xylabs/react-async-effect": "~3.0.18",
19
- "@xylabs/react-button": "~3.0.18",
20
- "@xylabs/react-common": "~3.0.18",
21
- "@xylabs/react-cookie-consent": "~3.0.18",
22
- "@xylabs/react-crypto": "~3.0.18",
23
- "@xylabs/react-dialogs": "~3.0.18",
24
- "@xylabs/react-experiments": "~3.0.18",
25
- "@xylabs/react-flexbox": "~3.0.18",
26
- "@xylabs/react-identicon": "~3.0.18",
27
- "@xylabs/react-invertible-theme": "~3.0.18",
28
- "@xylabs/react-link": "~3.0.18",
29
- "@xylabs/react-number-status": "~3.0.18",
30
- "@xylabs/react-pixel": "~3.0.18",
31
- "@xylabs/react-pixel-debugger": "~3.0.18",
32
- "@xylabs/react-promise": "~3.0.18",
33
- "@xylabs/react-quick-tip-button": "~3.0.18",
34
- "@xylabs/react-render-spin-check": "~3.0.18",
35
- "@xylabs/react-rich-result": "~3.0.18",
36
- "@xylabs/react-scroll-to-top": "~3.0.18",
37
- "@xylabs/react-shared": "~3.0.18"
16
+ "@xylabs/react-accordion": "~3.0.20",
17
+ "@xylabs/react-appbar": "~3.0.20",
18
+ "@xylabs/react-async-effect": "~3.0.20",
19
+ "@xylabs/react-button": "~3.0.20",
20
+ "@xylabs/react-common": "~3.0.20",
21
+ "@xylabs/react-cookie-consent": "~3.0.20",
22
+ "@xylabs/react-crypto": "~3.0.20",
23
+ "@xylabs/react-dialogs": "~3.0.20",
24
+ "@xylabs/react-experiments": "~3.0.20",
25
+ "@xylabs/react-flexbox": "~3.0.20",
26
+ "@xylabs/react-identicon": "~3.0.20",
27
+ "@xylabs/react-invertible-theme": "~3.0.20",
28
+ "@xylabs/react-link": "~3.0.20",
29
+ "@xylabs/react-number-status": "~3.0.20",
30
+ "@xylabs/react-pixel": "~3.0.20",
31
+ "@xylabs/react-pixel-debugger": "~3.0.20",
32
+ "@xylabs/react-promise": "~3.0.20",
33
+ "@xylabs/react-quick-tip-button": "~3.0.20",
34
+ "@xylabs/react-render-spin-check": "~3.0.20",
35
+ "@xylabs/react-rich-result": "~3.0.20",
36
+ "@xylabs/react-scroll-to-top": "~3.0.20",
37
+ "@xylabs/react-shared": "~3.0.20"
38
38
  },
39
39
  "description": "Common React library for all XY Labs projects that use React",
40
40
  "devDependencies": {
41
- "@babel/core": "^7.23.0",
42
- "@babel/preset-env": "^7.22.20",
41
+ "@babel/core": "^7.23.2",
42
+ "@babel/preset-env": "^7.23.2",
43
43
  "@babel/preset-react": "^7.22.15",
44
- "@babel/preset-typescript": "^7.23.0",
44
+ "@babel/preset-typescript": "^7.23.2",
45
45
  "@emotion/react": "^11.11.1",
46
46
  "@emotion/styled": "^11.11.0",
47
- "@mui/material": "^5.14.12",
47
+ "@mui/material": "^5.14.13",
48
48
  "@storybook/addon-actions": "^7.4.6",
49
49
  "@storybook/addon-docs": "^7.4.6",
50
50
  "@storybook/addon-essentials": "^7.4.6",
@@ -62,10 +62,10 @@
62
62
  "@storybook/theming": "^7.4.6",
63
63
  "@typescript-eslint/eslint-plugin": "^6.7.5",
64
64
  "@typescript-eslint/parser": "^6.7.5",
65
- "@xylabs/eslint-config-react": "^3.1.1",
65
+ "@xylabs/eslint-config-react": "^3.1.10",
66
66
  "@xylabs/pixel": "^1.4.14",
67
- "@xylabs/ts-scripts-yarn3": "^3.1.1",
68
- "@xylabs/tsconfig-react": "^3.1.1",
67
+ "@xylabs/ts-scripts-yarn3": "^3.1.10",
68
+ "@xylabs/tsconfig-react": "^3.1.10",
69
69
  "axios": "^1.5.1",
70
70
  "eslint": "^8.51.0",
71
71
  "eslint-import-resolver-typescript": "^3.6.1",
@@ -115,9 +115,6 @@
115
115
  },
116
116
  "default": "./dist/browser/index.js"
117
117
  },
118
- "./docs": {
119
- "default": "./dist/docs.json"
120
- },
121
118
  "./package.json": "./package.json"
122
119
  },
123
120
  "types": "dist/browser/index.d.ts",
@@ -143,7 +140,7 @@
143
140
  "build-typedoc-site": "xy gen-docs @xylabs/sdk-react && storybook build -o ./docs/storybook"
144
141
  },
145
142
  "sideEffects": false,
146
- "version": "3.0.18",
143
+ "version": "3.0.20",
147
144
  "packageManager": "yarn@3.6.1",
148
145
  "volta": {
149
146
  "node": "18.17.1",