@vygruppen/spor-icon-react-native 0.0.2
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 +37 -0
- package/dist/index.js +24864 -0
- package/dist/types.d.ts +1075 -0
- package/package.json +47 -0
package/README.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Icons (React Native)
|
|
2
|
+
|
|
3
|
+
This package includes all of our icons as React Native components.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
$ npm install @vygruppen/spor-icon-react-native
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { AddFilled16Icon } from "@vygruppen/spor-icon-react-native";
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
There are lots of icons - close to 1000 at last count. Most icons are designed for one of three to four sizes (12, 18, 24, 30 px), and available in a filled or outlined variant.
|
|
18
|
+
|
|
19
|
+
The naming scheme looks something like this:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
{name}{variant}{size}Icon
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### 🚨 Never import all icons!
|
|
26
|
+
|
|
27
|
+
When you're using these icons, never do `import * as icons from "@vygruppen/spor-icon-react-native"`! That will add over a megabyte to your JavaScript bundle, and render your app close to unusable on lower-end devices. 😱
|
|
28
|
+
|
|
29
|
+
Instead, import only the icons you need as named imports.
|
|
30
|
+
|
|
31
|
+
### Available icons
|
|
32
|
+
|
|
33
|
+
Please refer to the [documentation](https://spor.cloud.vy.no/ressurser/ikoner) for a complete list of icons:
|
|
34
|
+
|
|
35
|
+
## Development
|
|
36
|
+
|
|
37
|
+
Please refer to the root readme for development notes.
|