@vtmn/svelte
Advanced tools
Comparing version 0.0.2 to 0.0.3
@@ -6,2 +6,10 @@ # Change Log | ||
## [0.0.3](https://github.com/Decathlon/vitamin-web/compare/@vtmn/svelte@0.0.2...@vtmn/svelte@0.0.3) (2021-02-21) | ||
**Note:** Version bump only for package @vtmn/svelte | ||
## [0.0.2](https://github.com/Decathlon/vitamin-web/compare/@vtmn/svelte@0.0.1...@vtmn/svelte@0.0.2) (2021-02-20) | ||
@@ -8,0 +16,0 @@ |
{ | ||
"name": "@vtmn/svelte", | ||
"version": "0.0.2", | ||
"version": "0.0.3", | ||
"description": "Decathlon Design System - Vitamin Svelte library", | ||
@@ -52,3 +52,3 @@ "keywords": [ | ||
], | ||
"gitHead": "51c7a04c3f5f884f05d534bd8309406bab0ec116" | ||
"gitHead": "df7f31b256cf19636cfb3754a15aef533dc90b78" | ||
} |
# `@vtmn/svelte` | ||
> Decathlon Design System - Vitamin Svelte library | ||
> Decathlon Design System - Vitamin Svelte components library | ||
## Consuming Components | ||
<a href="https://decathlon.github.io/vitamin-web/@vtmn/showcase-svelte"><img src="https://img.shields.io/badge/storybook-svelte-F13C03?style=flat&logo=storybook" alt="storybook" /></a></a> | ||
<a href="https://www.npmjs.com/package/@vtmn/svelte"><img src="https://img.shields.io/npm/v/@vtmn/svelte?style=flat&logo=npm" alt="npm version" /></a> | ||
<a href="https://sonarcloud.io/dashboard?id=decathlon_vitamin-web_svelte"><img src="https://sonarcloud.io/api/project_badges/measure?project=decathlon_vitamin-web_svelte&metric=alert_status" alt="Quality Gate Status" /></a> | ||
## Install package | ||
After installing [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) or [yarn](https://yarnpkg.com/en/docs/install), you can install `@vtmn/svelte` with this command: | ||
```sh | ||
# with npm | ||
npm i -S @vtmn/svelte | ||
# with yarn | ||
yarn add @vtmn/svelte | ||
``` | ||
## Install fonts | ||
[Roboto](https://fonts.google.com/specimen/Roboto) & [Roboto Condensed](https://fonts.google.com/specimen/Roboto+Condensed) fonts as described in [Typography](https://www.decathlon.design/726f8c765/v/0/p/860e14-typography) section will not be automatically loaded. Fortunately, there is a few easy ways to get started. | ||
Shown below is a sample link markup used to load from a CDN: | ||
```html | ||
<link | ||
rel="stylesheet" | ||
href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&display=swap" | ||
/> | ||
<link | ||
rel="stylesheet" | ||
href="https://fonts.googleapis.com/css2?family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap" | ||
/> | ||
``` | ||
Otherwise, you can install them with `typeface`: | ||
```sh | ||
# with npm | ||
npm i -S typeface-roboto typeface-roboto-condensed | ||
# with yarn | ||
yarn add typeface-roboto typeface-roboto-condensed | ||
``` | ||
Then, you can import them in your entry-point: | ||
```javascript | ||
import 'typeface-roboto'; | ||
import 'typeface-roboto-condensed'; | ||
``` | ||
## Usage | ||
You may want to use the source Svelte files to benefit from some features (Server Side Rendering for instance). To do so, you will need to import components exposed in the `src/` folder of the package. | ||
@@ -19,1 +69,21 @@ | ||
``` | ||
## Development | ||
To know all the use cases and their associated code, [check out the showcase here](https://decathlon.github.io/vitamin-web/@vtmn/showcase-svelte). | ||
## Changelog | ||
If you want to know the different changes between versions of this package, [look at the changelog here](https://github.com/Decathlon/vitamin-web/blob/main/packages/sources/svelte/CHANGELOG.md). | ||
## I have an issue, what should I do? | ||
Please file the issue [here](https://github.com/Decathlon/vitamin-web/issues/new). | ||
## Contributing | ||
See [the contributing docs](https://github.com/Decathlon/vitamin-web/blob/main/CONTRIBUTING.md). | ||
## License | ||
Apache-2.0 © [Decathlon](https://github.com/Decathlon) |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
50641
89