1
- # rc-footer 🐾
1
+ # rc-segmented 🐾
2
2
3
3
[ ![ NPM version] [ npm-image ]] [ npm-url ] [ ![ npm download] [ download-image ]] [ download-url ] [ ![ dumi] ( https://img.shields.io/badge/docs%20by-dumi-blue?style=flat-square )] ( https://github.com/umijs/dumi ) [ ![ build status] [ github-actions-image ]] [ github-actions-url ] [ ![ Codecov] [ codecov-image ]] [ codecov-url ] [ ![ Dependencies] [ david-image ]] ( david-url ) [ ![ DevDependencies] [ david-dev-image ]] [ david-dev-url ] [ ![ bundle size] [ bundlephobia-image ]] [ bundlephobia-url ]
4
4
5
- [ npm-image ] : http://img.shields.io/npm/v/rc-footer .svg?style=flat-square
6
- [ npm-url ] : http://npmjs.org/package/rc-footer
7
- [ github-actions-image ] : https://github.com/react-component/footer /workflows/CI/badge.svg
8
- [ github-actions-url ] : https://github.com/react-component/footer /actions
9
- [ codecov-image ] : https://img.shields.io/codecov/c/github/react-component/footer /master.svg?style=flat-square
10
- [ codecov-url ] : https://codecov.io/gh/react-component/footer /branch/master
11
- [ david-url ] : https://david-dm.org/react-component/footer
12
- [ david-image ] : https://david-dm.org/react-component/footer /status.svg?style=flat-square
13
- [ david-dev-url ] : https://david-dm.org/react-component/footer ?type=dev
14
- [ david-dev-image ] : https://david-dm.org/react-component/footer /dev-status.svg?style=flat-square
15
- [ download-image ] : https://img.shields.io/npm/dm/rc-footer .svg?style=flat-square
16
- [ download-url ] : https://npmjs.org/package/rc-footer
17
- [ bundlephobia-url ] : https://bundlephobia.com/result?p=rc-footer
18
- [ bundlephobia-image ] : https://badgen.net/bundlephobia/minzip/rc-footer
19
-
20
- Pretty Footer react component used in [ ant.design] ( https://ant.design ) and [ antv.vision] ( https://antv.vision ) .
5
+ [ npm-image ] : http://img.shields.io/npm/v/rc-segmented .svg?style=flat-square
6
+ [ npm-url ] : http://npmjs.org/package/rc-segmented
7
+ [ github-actions-image ] : https://github.com/react-component/segmented /workflows/CI/badge.svg
8
+ [ github-actions-url ] : https://github.com/react-component/segmented /actions
9
+ [ codecov-image ] : https://img.shields.io/codecov/c/github/react-component/segmented /master.svg?style=flat-square
10
+ [ codecov-url ] : https://codecov.io/gh/react-component/segmented /branch/master
11
+ [ david-url ] : https://david-dm.org/react-component/segmented
12
+ [ david-image ] : https://david-dm.org/react-component/segmented /status.svg?style=flat-square
13
+ [ david-dev-url ] : https://david-dm.org/react-component/segmented ?type=dev
14
+ [ david-dev-image ] : https://david-dm.org/react-component/segmented /dev-status.svg?style=flat-square
15
+ [ download-image ] : https://img.shields.io/npm/dm/rc-segmented .svg?style=flat-square
16
+ [ download-url ] : https://npmjs.org/package/rc-segmented
17
+ [ bundlephobia-url ] : https://bundlephobia.com/result?p=rc-segmented
18
+ [ bundlephobia-image ] : https://badgen.net/bundlephobia/minzip/rc-segmented
19
+
20
+ Pretty segmented react component used in [ ant.design] ( https://ant.design ) and [ antv.vision] ( https://antv.vision ) .
21
21
22
22
![ ] ( https://gw.alipayobjects.com/zos/antfincdn/z4ie3X8x6u/1cb23945-ec67-45a3-b521-f8da62e12255.png )
23
23
24
24
## Live Demo
25
25
26
- https://react-component.github.io/footer /
26
+ https://react-component.github.io/segmented /
27
27
28
28
## Install
29
29
30
- [ ![ rc-footer ] ( https://nodei.co/npm/rc-footer .png )] ( https://npmjs.org/package/rc-footer )
30
+ [ ![ rc-segmented ] ( https://nodei.co/npm/rc-segmented .png )] ( https://npmjs.org/package/rc-segmented )
31
31
32
32
## Usage
33
33
34
34
``` js
35
- import Footer from ' rc-footer ' ;
36
- import ' rc-footer /assets/index.css' ; // import 'rc-footer /asssets/index.less';
35
+ import segmented from ' rc-segmented ' ;
36
+ import ' rc-segmented /assets/index.css' ; // import 'rc-segmented /asssets/index.less';
37
37
import { render } from ' react-dom' ;
38
38
39
39
render (
40
- < Footer
40
+ < segmented
41
41
columns= {[
42
42
{
43
43
icon: (
@@ -57,27 +57,27 @@ render(
57
57
58
58
## API
59
59
60
- | Property | Type | Default | Description |
61
- | ---------------- | --------------------------------- | -------------- | ---------------------------------------- |
62
- | prefixCls | string | rc-footer | |
63
- | className | string | '' | additional class name of footer |
64
- | style | React.CSSProperties | | style properties of footer |
65
- | columns | [ Column] ( #Column ) Array | [ ] | columns data inside footer |
66
- | bottom | ReactNode | | extra bottom area beneath footer columns |
67
- | theme | 'light' \| 'dark' | 'dark' | preset theme of footer |
68
- | backgroundColor | string | '#000 ' | background color of footer |
69
- | columnLayout | 'space-around' or 'space-between' | 'space-around' | justify-content value of columns element |
70
- | maxColumnsPerRow | number | - | max count of columns for each row |
60
+ | Property | Type | Default | Description |
61
+ | ---------------- | --------------------------------- | -------------- | ------------------------------------------- |
62
+ | prefixCls | string | rc-segmented | |
63
+ | className | string | '' | additional class name of segmented |
64
+ | style | React.CSSProperties | | style properties of segmented |
65
+ | columns | [ Column] ( #Column ) Array | [ ] | columns data inside segmented |
66
+ | bottom | ReactNode | | extra bottom area beneath segmented columns |
67
+ | theme | 'light' \| 'dark' | 'dark' | preset theme of segmented |
68
+ | backgroundColor | string | '#000 ' | background color of segmented |
69
+ | columnLayout | 'space-around' or 'space-between' | 'space-around' | justify-content value of columns element |
70
+ | maxColumnsPerRow | number | - | max count of columns for each row |
71
71
72
72
### Column
73
73
74
- | Property | Type | Default | Description |
75
- | --------- | -------------------------- | ------- | ------------------------------- |
76
- | icon | ReactNode | | icon that before column title |
77
- | title | ReactNode | | title of column |
78
- | items | [ Item] ( #Column-Item ) Array | [ ] | items data inside each column |
79
- | className | string | '' | additional class name of footer |
80
- | style | React.CSSProperties | | style properties of footer |
74
+ | Property | Type | Default | Description |
75
+ | --------- | -------------------------- | ------- | ---------------------------------- |
76
+ | icon | ReactNode | | icon that before column title |
77
+ | title | ReactNode | | title of column |
78
+ | items | [ Item] ( #Column-Item ) Array | [ ] | items data inside each column |
79
+ | className | string | '' | additional class name of segmented |
80
+ | style | React.CSSProperties | | style properties of segmented |
81
81
82
82
### Column Item
83
83
@@ -88,8 +88,8 @@ render(
88
88
| description | ReactNode | | description of column, come after title |
89
89
| url | string | | link url of item title |
90
90
| openExternal | boolean | false | link target would be ` _blank ` if ` openExternal ` is ture |
91
- | className | string | '' | additional class name of footer |
92
- | style | React.CSSProperties | | style properties of footer |
91
+ | className | string | '' | additional class name of segmented |
92
+ | style | React.CSSProperties | | style properties of segmented |
93
93
| LinkComponent | React.ReactType | 'a' | the link element to render item |
94
94
95
95
## Development
@@ -101,4 +101,4 @@ npm start
101
101
102
102
## License
103
103
104
- rc-footer is released under the MIT license.
104
+ rc-segmented is released under the MIT license.
0 commit comments