Skip to content

Commit faf75dc

Browse files
committed
.
1 parent 2b18ba1 commit faf75dc

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,10 @@
22

33
> Dynamic bracket component, usable for brackets such as single elimination and double elimination
44
5-
65
[![NPM](https://img.shields.io/npm/v/react-brackets.svg)](https://www.npmjs.com/package/react-brackets) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
76

8-
![react-brackets](https://github.com/mohux/react-brackets/blob/master/images/web.gif?raw=true "react-brackets")
9-
![react-brackets](https://github.com/mohux/react-brackets/blob/master/images/mobile.gif?raw=true "react-brackets")
10-
7+
![react-brackets](https://github.com/mohux/react-brackets/blob/master/images/web.gif?raw=true 'react-brackets')
8+
![react-brackets](https://github.com/mohux/react-brackets/blob/master/images/mobile.gif?raw=true 'react-brackets')
119

1210
## Install
1311

@@ -153,18 +151,19 @@ const Component = () => {
153151
154152
## Bracket Props
155153
156-
|Prop|Type | Description|
157-
|--|--|--|
158-
| rounds| RoundProps[]| Array of rounds, each round has {title,array of seeds}, if you're not using a custom seed render, each seed needs an array of teams, each team should have a name|
159-
| mobileBreakpoint | number | This bracket supports responsive design, on window reaching this size, it will trigger mobile swipable view, if you want to disable it, you can pass 0, (default is 992) |
160-
| rtl| boolean| Direction of the bracket as RTL (default is LTR) |
161-
| roundClassName| string| Round wrapper className |
162-
| bracketClassName| string| The bracket className |
163-
| renderSeedComponent| functional component| Custom render for every seed |
164-
| roundTitleComponent| functional component| Custom render for every round title|
165-
| swipeableProps| SwipeableProps | Please check this [React Swipeable Views](https://github.com/oliviertassinari/react-swipeable-views)|
154+
| Prop | Type | Description |
155+
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
156+
| rounds | RoundProps[] | Array of rounds, each round has {title,array of seeds}, if you're not using a custom seed render, each seed needs an array of teams, each team should have a name |
157+
| mobileBreakpoint | number | This bracket supports responsive design, on window reaching this size, it will trigger mobile swipable view, if you want to disable it, you can pass 0, (default is 992) |
158+
| rtl | boolean | Direction of the bracket as RTL (default is LTR) |
159+
| roundClassName | string | Round wrapper className |
160+
| bracketClassName | string | The bracket className |
161+
| renderSeedComponent | functional component | Custom render for every seed |
162+
| roundTitleComponent | functional component | Custom render for every round title |
163+
| swipeableProps | SwipeableProps | Please check this [React Swipeable Views](https://github.com/oliviertassinari/react-swipeable-views) |
166164
167165
For detailed examples, you can clone this repo then:
166+
168167
> you can skip starting the root folder, but if you want to modify the library you have to run it.
169168
170169
```bash
@@ -176,6 +175,7 @@ then
176175
```bash
177176
yarn start
178177
```
178+
179179
then open a new terminal
180180
181181
```bash
@@ -196,4 +196,4 @@ yarn start
196196
197197
## License
198198
199-
MIT © [mohux](https://github.com/mohux)
199+
MIT © [mohammadou1](https://github.com/mohammadou1)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-brackets",
3-
"version": "0.4.3",
3+
"version": "0.4.4",
44
"description": "React component to render dynamic bracket UI",
55
"author": "mohux",
66
"license": "MIT",

0 commit comments

Comments
 (0)