@pingux/astro 1.44.0-alpha.9 → 1.44.1
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/CHANGELOG.md +31 -0
- package/NOTICE.html +4763 -0
- package/README.md +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# `@pingux/astro`
|
|
2
2
|
|
|
3
|
-
Astro is a lightweight, composable, and themeable React component library. Astro was created to help developers and designers create consistent, user friendly, and accessible UIs across all Ping products. Please visit https://pingidentity.design for more information
|
|
3
|
+
Astro is a lightweight, composable, and themeable React component library. Astro was created to help developers and designers create consistent, user friendly, and accessible UIs across all Ping products. Please visit https://pingidentity.design for more information. To read individual component documentation, [our Storybook docs site](https://storybook.pingidentity.design) is a great resource.
|
|
4
4
|
|
|
5
5
|
## Installing
|
|
6
6
|
|
|
@@ -21,8 +21,8 @@ Yarn:
|
|
|
21
21
|
|
|
22
22
|
All apps should be wrapped in an `<AstroWrapper>` for full functionality and styling.
|
|
23
23
|
|
|
24
|
-
```
|
|
25
|
-
import { AstroWrapper } from
|
|
24
|
+
```js
|
|
25
|
+
import { AstroWrapper } from '@pingux/astro';
|
|
26
26
|
|
|
27
27
|
<AstroWrapper>
|
|
28
28
|
<App />
|
|
@@ -37,9 +37,9 @@ Astro uses [Storybook](https://storybook.js.org/) for component documentation. O
|
|
|
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
|
|
|
40
|
-
Component prop documentation is available under the
|
|
40
|
+
Component prop documentation is available under the "documentation" tab per each component story. Most props can be toggled and configured for preview purposes within the prop table.
|
|
41
41
|
|
|
42
|
-
For example, to view the disabled button styling, navigate to the Button story’s props table, locate the
|
|
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
44
|
|
|
45
45
|
## Browser Compatibility
|