@pingux/astro 2.161.1-alpha.3 → 2.161.1-alpha.4
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/lib/README.md
CHANGED
|
@@ -14,7 +14,7 @@ Yarn:
|
|
|
14
14
|
|
|
15
15
|
## Requirements
|
|
16
16
|
|
|
17
|
-
- Node:
|
|
17
|
+
- Node: 20+
|
|
18
18
|
- React: 16.8+
|
|
19
19
|
|
|
20
20
|
## Usage
|
|
@@ -33,7 +33,7 @@ import { AstroProvider } from '@pingux/astro';
|
|
|
33
33
|
|
|
34
34
|
Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
|
|
35
35
|
|
|
36
|
-
`
|
|
36
|
+
`npx nx start`
|
|
37
37
|
|
|
38
38
|
The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at https://storybook.js.org/docs/react/api/cli-options.
|
|
39
39
|
|
|
@@ -41,19 +41,23 @@ Component prop documentation is available under the "documentation" tab per each
|
|
|
41
41
|
|
|
42
42
|
For example, to view the disabled button styling, navigate to the Button story’s props table, locate the "isDisabled" prop, and toggle to "true". This change allows you to preview the disabled button’s styling and functionality.
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
We use a modern version of [Yarn](https://yarnpkg.com/getting-started) for package management with the [Plug'n'Play](https://yarnpkg.com/features/pnp) feature enabled. This allows for a [Zero Install](https://yarnpkg.com/features/zero-installs) approach to be used.
|
|
44
|
+
To create a production bundle:
|
|
46
45
|
|
|
47
|
-
|
|
46
|
+
```sh
|
|
47
|
+
npx nx build astro
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
To run linting:
|
|
48
51
|
|
|
49
|
-
|
|
52
|
+
```sh
|
|
53
|
+
npx nx lint astro
|
|
54
|
+
```
|
|
50
55
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
b. Choose "Use Workspace Version"
|
|
56
|
+
To run unit tests:
|
|
57
|
+
|
|
58
|
+
```sh
|
|
59
|
+
npx nx test astro
|
|
60
|
+
```
|
|
57
61
|
|
|
58
62
|
## Browser Compatibility
|
|
59
63
|
|
|
@@ -28,7 +28,7 @@ Yarn:
|
|
|
28
28
|
|
|
29
29
|
### Requirements
|
|
30
30
|
|
|
31
|
-
- Node:
|
|
31
|
+
- Node: 20+
|
|
32
32
|
- React: 16.8+
|
|
33
33
|
|
|
34
34
|
### Usage
|
|
@@ -47,7 +47,7 @@ import { AstroProvider } from ‘@pingux/astro’;
|
|
|
47
47
|
|
|
48
48
|
Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
|
|
49
49
|
|
|
50
|
-
`
|
|
50
|
+
Run `npm install` in the root and package level. Followed by `npx nx start` in lib/astro.
|
|
51
51
|
|
|
52
52
|
The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at the [Storybook docs](https://storybook.js.org/docs/react/api/cli-options).
|
|
53
53
|
|
|
@@ -28,7 +28,7 @@ Yarn:
|
|
|
28
28
|
|
|
29
29
|
### Requirements
|
|
30
30
|
|
|
31
|
-
- Node:
|
|
31
|
+
- Node: 20+
|
|
32
32
|
- React: 16.8+
|
|
33
33
|
|
|
34
34
|
### Usage
|
|
@@ -47,7 +47,7 @@ import { AstroProvider } from ‘@pingux/astro’;
|
|
|
47
47
|
|
|
48
48
|
Astro uses [Storybook](https://storybook.js.org/) for component documentation. Once Astro has been cloned, run the following commands to start a local Storybook server:
|
|
49
49
|
|
|
50
|
-
`
|
|
50
|
+
Run `npm install` in the root and package level. Followed by `npx nx start` in lib/astro.
|
|
51
51
|
|
|
52
52
|
The Storybook server defaults to `https://localhost:6006`. This port can be customized by running the command start -p 9009. For example, this will start Storybook on port 9009. More information on customizing Storybook CLI options can be found at the [Storybook docs](https://storybook.js.org/docs/react/api/cli-options).
|
|
53
53
|
|