react-brackets

> Dynamic bracket component, usable for brackets such as single elimination and double elimination

 

!react-brackets
!react-brackets

Install

via npm

``bash

npm install --save react-brackets

`

via yarn

`bash

yarn add --save react-brackets

`

Usage

The simplest usage of this component is

`jsx
import { Bracket, RoundProps } from 'react-brackets';

const rounds: RoundProps[] = [
{
title: 'Round one',
seeds: [
{
id: 1,
date: new Date().toDateString(),
teams: [{ name: 'Team A' }, { name: 'Team B' }],
},
{
id: 2,
date: new Date().toDateString(),
teams: [{ name: 'Team C' }, { name: 'Team D' }],
},
],
},
{
title: 'Round one',
seeds: [
{
id: 3,
date: new Date().toDateString(),
teams: [{ name: 'Team A' }, { name: 'Team C' }],
},
],
},
];

const Component = () => {
return ;
};
`

The core shape is similar to the above, since we can customize seeds and titles, you can pass any additional data to a seed or treat the title as a component.

modifying a title of the round is so simple,

`jsx
import { Bracket, RoundProps } from 'react-brackets';
import React from 'react';

const Component = () => {
//....
return (
rounds={rounds}
roundTitleComponent={(title: React.ReactNode, roundIndex: number) => {
return

;
}}
/>
);
};
`

Customizing a seed on the other hand is a little bit more complicated, yet still easy,
because we need to let the bracket tree to have a consitent design

Any additional data you pass inside a seed object is accessibile via renderSeedComponent

`jsx
import { Bracket, RoundProps, Seed, SeedItem, SeedTeam, RenderSeedProps } from 'react-brackets';
import React from 'react';

const CustomSeed = ({seed, breakpoint, roundIndex, seedIndex}: RenderSeedProps) => {
// breakpoint passed to Bracket component
// to check if mobile view is triggered or not

// mobileBreakpoint is required to be passed down to a seed
return (




);
};

const Component = () => {
//....
return ;
};
`

How about if I want to use this component for double elimination losing bracket? the current Seed component only works on single elimination, the answer is fairly simple as well.

`jsx
import { Bracket, RoundProps, Seed, SingleLineSeed, SeedItem, SeedTeam, RenderSeedProps } from 'react-brackets';
import React from 'react';

const CustomSeed = ({seed, breakpoint, roundIndex, seedIndex}: RenderSeedProps) => {
// ------ assuming rounds is the losers brackets rounds ------
// losers rounds usually got some identical seeds amount like (2 - 2 - 1 - 1)

const isLineConnector = rounds[roundIndex].seeds.length === rounds[roundIndex + 1]?.seeds.length;

const Wrapper = isLineConnector ? SingleLineSeed : Seed;

// mobileBreakpoint is required to be passed down to a seed
return (




);
};

const Component = () => {
//....
return ;
};
`

Bracket Props

| Prop | Type | Description |
| ------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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 |
| 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) |
| rtl | boolean | Direction of the bracket as RTL (default is LTR) |
| roundClassName | string | Round wrapper className |
| bracketClassName | string | The bracket className |
| renderSeedComponent | functional component | Custom render for every seed |
| roundTitleComponent | functional component | Custom render for every round title |
| swipeableProps | SwipeableProps | Please check this React Swipeable Views |

For detailed examples, you can clone this repo then:

> you can skip starting the root folder, but if you want to modify the library you have to run it.

`bash
yarn
`

then

`bash
yarn start
`

then open a new terminal

`bash
cd example
`

then

`bash
yarn
`

lastly

`bash
yarn start
``

License

MIT © mohammadou1