@sb1/ffe-symbols 3.0.0 → 4.0.0
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 +3 -62
- package/ffe-symbol.less +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,66 +1,7 @@
|
|
|
1
1
|
# @sb1/ffe-symbols
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## Deprecated package
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
npm install --save @sb1/ffe-symbols
|
|
7
|
-
```
|
|
5
|
+
This package is deprecated, and will be removed from the designsystem repo.
|
|
8
6
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
Full documentation on icon usage is available at https://design.sparebank1.no/komponenter/ikoner/.
|
|
12
|
-
|
|
13
|
-
There are two ways to use `ffe-symbols`:
|
|
14
|
-
|
|
15
|
-
1. Copy the font files from `node_modules/@sb1/ffe-symbols/icons/` and use `ffe-symbol.less`
|
|
16
|
-
2. Use `ffe-symbol.css`, where the icon font is base64 encoded inline
|
|
17
|
-
|
|
18
|
-
Approach 1 is probably what you want for performance reasons.
|
|
19
|
-
|
|
20
|
-
### Using Less
|
|
21
|
-
|
|
22
|
-
Copy the font files from `node_modules/@sb1/ffe-symbols/icons/` to a folder that will be shipped with your app. You can use npm-scripts, (if you use Webpack) [copy-webpack-plugin](https://github.com/webpack-contrib/copy-webpack-plugin), or whatever you see fit to get the files to where they need to be.
|
|
23
|
-
|
|
24
|
-
Import `node_modules/@sb1/ffe-symbols/ffe-symbol.less` in your app:
|
|
25
|
-
|
|
26
|
-
```less
|
|
27
|
-
@import 'npm://@sb1/ffe-symbols/ffe-symbol.less'; // with less-plugin
|
|
28
|
-
@import '~@sb1/ffe-symbols/ffe-symbol.less'; // with webpack and less-loader
|
|
29
|
-
@import '../path/to/node_modules/@sb1/ffe-symbols/ffe-symbol.less'; // by path
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
You need to provide a constant named `@icons-url` after the `@import` with a URL path to the fonts folder so the browser knows where to download the font files.
|
|
33
|
-
|
|
34
|
-
```less
|
|
35
|
-
@import '~@sb1/ffe-symbols/ffe-symbol.less';
|
|
36
|
-
@icons-url: '/privat/forsikring/icons';
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### CSS with inline fonts
|
|
40
|
-
|
|
41
|
-
```css
|
|
42
|
-
@import url('~@sb1/ffe-symbols/ffe-symbol.css');
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
```less
|
|
46
|
-
@import (inline) '~@sb1/ffe-symbols/ffe-symbol.css';
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
## React component
|
|
50
|
-
|
|
51
|
-
See `@sb1/ffe-symbols-react`.
|
|
52
|
-
|
|
53
|
-
## Development
|
|
54
|
-
|
|
55
|
-
To start a local development server, run the following from the designsystem root folder:
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
npm install
|
|
59
|
-
npm run build
|
|
60
|
-
npm start
|
|
61
|
-
```
|
|
62
|
-
|
|
63
|
-
A local instance of `component-overview` with live reloading will run at http://localhost:1234/.
|
|
64
|
-
NOTE: `component-overview` uses the css-implementation, so you'll have to run `npm run build` to see the changes made to the styling.
|
|
65
|
-
|
|
66
|
-
Example implementations using the latest versions of all components are also available at https://sparebank1.github.io/designsystem.
|
|
7
|
+
To use the new set of icons, please refer to [ffe-icons](https://github.com/SpareBank1/designsystem/tree/develop/packages/ffe-icons) and/or [ffe-icons-react](https://github.com/SpareBank1/designsystem/tree/develop/packages/ffe-icons-react).
|
package/ffe-symbol.less
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sb1/ffe-symbols",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "4.0.0",
|
|
4
4
|
"description": "Styling for tilpasning av material symbols til Sb1",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
10
10
|
},
|
|
11
11
|
"devDependencies": {
|
|
12
|
-
"@sb1/ffe-buildtool": "^0.5.
|
|
12
|
+
"@sb1/ffe-buildtool": "^0.5.2",
|
|
13
13
|
"less": "^4.1.2"
|
|
14
14
|
},
|
|
15
15
|
"repository": {
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"publishConfig": {
|
|
34
34
|
"access": "public"
|
|
35
35
|
},
|
|
36
|
-
"gitHead": "
|
|
36
|
+
"gitHead": "c2e7c509b580bc205ca92d91b7e2e2c0503a0087"
|
|
37
37
|
}
|