Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eioluseyi/idares-ui
https://github.com/eioluseyi/idares-ui
website-project
Last synced: about 4 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/eioluseyi/idares-ui
- Owner: eioluseyi
- Created: 2022-08-09T22:38:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-17T09:02:42.000Z (over 1 year ago)
- Last Synced: 2025-01-02T02:35:28.940Z (11 days ago)
- Topics: website-project
- Language: TypeScript
- Homepage: https://idares-ui.netlify.app/
- Size: 926 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# iDares UI
###### A collection of select accessible and customizable react UI components.
---
#### Table of contents
1. [ Available components ](#available-components)
2. [ Installation ](#installation)
3. [ Usage ](#usage)
- [Default usage](#default-usage)
- [Control `page`](#control-page)
- [Props](#props)
4. [ Storybook docs ](#story-book)
##### Available components
- Pagination
- ...
##### Installation
Using npm:
```javascript
$ npm install @idares-ui/react
```
Using yarn:
```javascript
$ yarn add @idares-ui/react
```
##### Usage
###### Default usage
```javascript
import { Pagination } from "@idares-ui/react";
...
...
```
###### Control `page` in your component
```javascript
import { Pagination } from "@idares-ui/react";
...
const [page, setPage] = React.useState(1);
...
...
```
###### Props and default values
| Prop | Type | Default |
| --------- | :------: | ------: |
| page | number | `1` |
| perPage | number | `10` |
| count | number | `60` |
| setPage | function | `void` |
| baseSize | bsType | `"xl"` |
| baseColor | string | `null` |
```typescript
bsType = "xs" | "sm" | "md" | "lg" | "xl" |
```
##### Storybook docs
View the full Storybook documentation [ here ](https://idares-ui.netlify.app)