rc-footer
Version:
Pretty Footer react component used in ant.design
105 lines (83 loc) • 5.54 kB
Markdown
# rc-footer 🐾
[![NPM version][npm-image]][npm-url] [![npm download][download-image]][download-url] [](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]
[npm-image]: http://img.shields.io/npm/v/rc-footer.svg?style=flat-square
[npm-url]: http://npmjs.org/package/rc-footer
[github-actions-image]: https://github.com/react-component/footer/workflows/CI/badge.svg
[github-actions-url]: https://github.com/react-component/footer/actions
[codecov-image]: https://img.shields.io/codecov/c/github/react-component/footer/master.svg?style=flat-square
[codecov-url]: https://codecov.io/gh/react-component/footer/branch/master
[david-url]: https://david-dm.org/react-component/footer
[david-image]: https://david-dm.org/react-component/footer/status.svg?style=flat-square
[david-dev-url]: https://david-dm.org/react-component/footer?type=dev
[david-dev-image]: https://david-dm.org/react-component/footer/dev-status.svg?style=flat-square
[download-image]: https://img.shields.io/npm/dm/rc-footer.svg?style=flat-square
[download-url]: https://npmjs.org/package/rc-footer
[bundlephobia-url]: https://bundlephobia.com/result?p=rc-footer
[bundlephobia-image]: https://badgen.net/bundlephobia/minzip/rc-footer
Pretty Footer react component used in [ant.design](https://ant.design) and [antv.vision](https://antv.vision).
## Live Demo
https://react-component.github.io/footer/
## Install
[](https://npmjs.org/package/rc-footer)
## Usage
```js
import Footer from 'rc-footer';
import 'rc-footer/assets/index.css'; // import 'rc-footer/asssets/index.less';
import { render } from 'react-dom';
render(
<Footer
columns={[
{
icon: (
<img src="https://gw.alipayobjects.com/zos/rmsportal/XuVpGqBFxXplzvLjJBZB.svg" />
),
title: '语雀',
url: 'https://yuque.com',
description: '知识创作与分享工具',
openExternal: true,
},
]}
bottom="Made with ❤️ by AFX"
/>,
mountNode,
);
```
## API
| Property | Type | Default | Description |
| ---------------- | --------------------------------- | -------------- | ---------------------------------------- |
| prefixCls | string | rc-footer | |
| className | string | '' | additional class name of footer |
| style | React.CSSProperties | | style properties of footer |
| columns | [Column](#Column) Array | [] | columns data inside footer |
| bottom | ReactNode | | extra bottom area beneath footer columns |
| theme | 'light' \| 'dark' | 'dark' | preset theme of footer |
| backgroundColor | string | '#000' | background color of footer |
| columnLayout | 'space-around' \| 'space-between' | 'space-around' | justify-content value of columns element |
| maxColumnsPerRow | number | - | max count of columns for each row |
### Column
| Property | Type | Default | Description |
| --------- | -------------------------- | ------- | ------------------------------- |
| icon | ReactNode | | icon that before column title |
| title | ReactNode | | title of column |
| items | [Item](#Column-Item) Array | [] | items data inside each column |
| className | string | '' | additional class name of footer |
| style | React.CSSProperties | | style properties of footer |
### Column Item
| Property | Type | Default | Description |
| ------------- | ------------------- | ------- | ------------------------------------------------------- |
| icon | ReactNode | | icon that before column title |
| title | ReactNode | | title of column |
| description | ReactNode | | description of column, come after title |
| url | string | | link url of item title |
| openExternal | boolean | false | link target would be `_blank` if `openExternal` is ture |
| className | string | '' | additional class name of footer |
| style | React.CSSProperties | | style properties of footer |
| LinkComponent | React.ReactType | 'a' | the link element to render item |
## Development
```
npm install
npm start
```
## License
rc-footer is released under the MIT license.