@sb1/ffe-cards 15.0.1 → 15.0.3

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.
Files changed (2) hide show
  1. package/README.md +26 -0
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -8,6 +8,8 @@ npm install --save @sb1/ffe-core @sb1/ffe-cards
8
8
 
9
9
  ## Usage
10
10
 
11
+ Full documentation on card usage is available at https://design.sparebank1.no/komponenter/kort/.
12
+
11
13
  Import styling for all card types:
12
14
 
13
15
  ```less
@@ -23,3 +25,27 @@ Or pick just the ones you need from these:
23
25
  ```
24
26
 
25
27
  See also `@sb1/ffe-cards-react`.
28
+
29
+ ## Theming with CSS custom properties
30
+
31
+ In order to support theming of components, this package contains styling that depends on a set of custom properties, defined in `less/theme.less`. These properties in turn depend on a base theme defined in `ffe-core`.
32
+
33
+ If your project uses the `ffe-core`, you're probably good to go. If not, make sure to import the core properties in `theme.less`:
34
+
35
+ ```css
36
+ @import '~@sb1/ffe-core/less/theme';
37
+ ```
38
+
39
+ ## Development
40
+
41
+ To start a local development server, run the following from the designsystem root folder:
42
+
43
+ ```bash
44
+ npm install
45
+ npm run build
46
+ npm start
47
+ ```
48
+
49
+ A local instance of `component-overview` with live reloading will run at http://localhost:1234/.
50
+
51
+ Example implementations using the latest versions of all components are also available at https://sparebank1.github.io/designsystem.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sb1/ffe-cards",
3
- "version": "15.0.1",
3
+ "version": "15.0.3",
4
4
  "description": "Kort for bruk i oversikter",
5
5
  "license": "MIT",
6
6
  "author": "SpareBank 1",
@@ -16,7 +16,7 @@
16
16
  "test": "npm run lint"
17
17
  },
18
18
  "dependencies": {
19
- "@sb1/ffe-core": "^26.1.2"
19
+ "@sb1/ffe-core": "^27.0.1"
20
20
  },
21
21
  "devDependencies": {
22
22
  "@sb1/ffe-buildtool": "^0.5.0"
@@ -24,5 +24,5 @@
24
24
  "publishConfig": {
25
25
  "access": "public"
26
26
  },
27
- "gitHead": "5fdea099a3e13e367c3288738656b366c2b168e8"
27
+ "gitHead": "1ab898e744977e4cb4db1bee9b65369a0deeef9a"
28
28
  }