@pagopa/io-app-design-system 1.0.0-10 → 1.0.0-11
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 +38 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,23 +1,57 @@
|
|
|
1
|
-
# io-app-design-system
|
|
1
|
+
# @pagopa/io-app-design-system
|
|
2
2
|
|
|
3
3
|
The library defining the core components of the design system of io-app
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```sh
|
|
8
|
-
|
|
8
|
+
yarn add @pagopa/io-app-design-system
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
12
12
|
|
|
13
13
|
```js
|
|
14
|
-
import {
|
|
14
|
+
import { IOStyles } from '@pagopa/io-app-design-system';
|
|
15
15
|
|
|
16
16
|
// ...
|
|
17
17
|
|
|
18
|
-
const
|
|
18
|
+
const Component = () => (
|
|
19
|
+
<View style={IOStyles.flex}>
|
|
20
|
+
// ... Further component code
|
|
21
|
+
</View>
|
|
22
|
+
);
|
|
19
23
|
```
|
|
20
24
|
|
|
25
|
+
The list of the component exported by the library is the following:
|
|
26
|
+
|
|
27
|
+
* [Accordion](./src/components/accordion/)
|
|
28
|
+
* [Advice](./src/components/advice/)
|
|
29
|
+
* [Alert](./src/components/alert/)
|
|
30
|
+
* [Avatar](./src/components/avatar/)
|
|
31
|
+
* [Badge](./src/components/badge/)
|
|
32
|
+
* [Banner](./src/components/banner/)
|
|
33
|
+
* [Buttons](./src/components/buttons/)
|
|
34
|
+
* [Checkbox](./src/components/checkbox/)
|
|
35
|
+
* [contentWrapper](./src/components/contentWrapper/)
|
|
36
|
+
* [Divider](./src/components/divider/)
|
|
37
|
+
* [Icons](./src/components/icons/)
|
|
38
|
+
* [List Items](./src/components/listitems/)
|
|
39
|
+
* [Logos](./src/components/logos/)
|
|
40
|
+
* [Pictograms](./src/components/pictograms/)
|
|
41
|
+
* [Radio](./src/components/radio/)
|
|
42
|
+
* [Spacer](./src/components/spacer/)
|
|
43
|
+
* [Switch](./src/components/switch/)
|
|
44
|
+
* [Tag](./src/components/tag/)
|
|
45
|
+
* [Typography](./src/components/typography/)
|
|
46
|
+
|
|
47
|
+
A part from the components, the library also exports the following core elements and styles as part of the [core attributes](./src/core/) of the design system, and common functions used to wrap up external libraries and utilities (here listed as [functions](./src/functions/)).
|
|
48
|
+
|
|
49
|
+
## External dependencies
|
|
50
|
+
* [react-native-svg](https://github.com/software-mansion/react-native-svg)
|
|
51
|
+
* [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated)
|
|
52
|
+
* [react-native-linear-gradient](https://github.com/react-native-linear-gradient/react-native-linear-gradient)
|
|
53
|
+
* [react-native-haptic-feedback](https://github.com/mkuczera/react-native-haptic-feedback)
|
|
54
|
+
|
|
21
55
|
## Contributing
|
|
22
56
|
|
|
23
57
|
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
|