File tree 1 file changed +25
-4
lines changed
1 file changed +25
-4
lines changed Original file line number Diff line number Diff line change @@ -4,23 +4,44 @@ Various stylish card components for React.
4
4
Focused on being ready to use with little modifications. Supply your data and you're good to go.
5
5
6
6
## Live demo
7
- https://nukeop.github.io/react-ui-cards/
7
+ https://nukeop.github.io/react-ui-cards
8
8
9
9
## npm
10
10
https://www.npmjs.com/package/react-ui-cards
11
11
12
- ## Installation
12
+ ## Installation and usage example
13
+ Minified and gzipped bundle size: 52kb.
13
14
``` bash
14
15
$ npm install --save react-ui-cards
15
16
```
16
17
18
+ ``` typescript
19
+ import { UserCard } from ' react-ui-cards' ;
20
+
21
+ export const Example = () => <UserCard
22
+ float
23
+ href =' https://github.com/nukeop'
24
+ header =' https://i.imgur.com/vRAtM3i.jpg'
25
+ avatar =' https://i.imgur.com/XJxqvsU.jpg'
26
+ name =' Frank Hepsfield'
27
+ positionName =' Software Engineering Manager'
28
+ />
29
+ ```
30
+
17
31
## Development
18
32
### Getting started
19
- After cloning the repo, run the following commands to start the project in development mode with hot reload:
33
+ After cloning the repo, run the following commands to start Storybook in development mode with hot reload:
20
34
21
35
``` shell
22
36
$ npm install
23
- $ npm run dev
37
+ $ npm run storybook
38
+ ```
39
+
40
+ ### Running tests
41
+ The repo is configured so that it generates snapshot tests from Storybook stories. To run them, use:
42
+
43
+ ``` shell
44
+ $ npm test
24
45
```
25
46
26
47
### Contributing
You can’t perform that action at this time.
0 commit comments