0.0.2 • Published 7 years ago

react-web-pull-to-refresh v0.0.2

Weekly downloads
7
License
MIT
Repository
github
Last release
7 years ago

Build Status MIT License

react-web-pull-to-refresh

A pull to refresh React component.

Installation

npm install --save react-web-pull-to-refresh

Usage

react-web-pull-to-refresh provides PullDownToRefresh component.

API

<PullDownToRefresh />

A pull to refresh component. Please wrap a content which should be pull down area.

  • className (string) : CSS class name for PullDownToRefresh
  • displayFlag (boolean): displayFlag for loading area
  • pullDownHandler (Function): pull down handler
  • borderHeight (number): loading area setting
  • height (number): loading area setting
  • fontSize (string): loading area setting
  • threshold (number): loading area setting
  • loadingContent (string | React.Element<*>): loading area setting

Development

Setup

npm install --global yarn
yarn install
yarn build

Start dev server for examples

yarn start

Open http://localhost:8080/.

Run test

yarn test

Commit Message Format

Each commit message consists of some types, a subject.

<type>: <subject>
<BLANK LINE>
<body>

Type

Type Must be one of the following:

  • feat: A new feature
  • fix: A bug fix
  • workaround: A workaround
  • docs: Documentation only changes
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • refactor: A code change that neither fixes a bug nor adds a feature
  • perf: A code change that improves performance
  • test: Adding missing or correcting existing tests
  • chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

TODO:

  • Add useful tests.
  • Add PullUpToRefresh component

Reference Implementation

Changelog

See the Releases page on GitHub.

License

MIT

Author

Kazuhiko Mori (mori.dev.asdf@gmail.com)