Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[IOPLT-97] Updates readme for the library #27

Merged
merged 3 commits into from
Jul 20, 2023
+38 −4
Merged

[IOPLT-97] Updates readme for the library #27

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3208875
[IOPLT-97] Updates readme for the library
CrisTofani Jul 19, 2023
0e4e33c
Merge branch 'main' into IOPLT-97-readme-update
CrisTofani Jul 20, 2023
6d8bde9
Merge branch 'main' into IOPLT-97-readme-update
CrisTofani Jul 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 38 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,57 @@
# io-app-design-system
# @pagopa/io-app-design-system

The library defining the core components of the design system of io-app

## Installation

```sh
npm install io-app-design-system
yarn add @pagopa/io-app-design-system
```

## Usage

```js
import { multiply } from 'io-app-design-system';
import { IOStyles } from '@pagopa/io-app-design-system';

// ...

const result = await multiply(3, 7);
const Component = () => (
<View style={IOStyles.flex}>
// ... Further component code
</View>
);
```

The list of the component exported by the library is the following:

* [Accordion](./src/components/accordion/)
* [Advice](./src/components/advice/)
* [Alert](./src/components/alert/)
* [Avatar](./src/components/avatar/)
* [Badge](./src/components/badge/)
* [Banner](./src/components/banner/)
* [Buttons](./src/components/buttons/)
* [Checkbox](./src/components/checkbox/)
* [contentWrapper](./src/components/contentWrapper/)
* [Divider](./src/components/divider/)
* [Icons](./src/components/icons/)
* [List Items](./src/components/listitems/)
* [Logos](./src/components/logos/)
* [Pictograms](./src/components/pictograms/)
* [Radio](./src/components/radio/)
* [Spacer](./src/components/spacer/)
* [Switch](./src/components/switch/)
* [Tag](./src/components/tag/)
* [Typography](./src/components/typography/)

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/)).

## External dependencies
* [react-native-svg](https://github.com/software-mansion/react-native-svg)
* [react-native-reanimated](https://github.com/software-mansion/react-native-reanimated)
* [react-native-linear-gradient](https://github.com/react-native-linear-gradient/react-native-linear-gradient)
* [react-native-haptic-feedback](https://github.com/mkuczera/react-native-haptic-feedback)

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down