@react-brackets/core 0.0.0-stage → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -2
- package/dist/index.cjs +747 -0
- package/dist/index.d.cts +460 -0
- package/dist/index.d.ts +460 -0
- package/dist/index.js +704 -0
- package/package.json +52 -4
package/README.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @react-brackets/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The framework-agnostic engine behind [react-brackets](https://github.com/MohOulabi/react-brackets): tournament formats, results, standings and layout, with no dependencies.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install @react-brackets/core
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import { reportResult, singleElimination, standings } from '@react-brackets/core';
|
|
11
|
+
|
|
12
|
+
let stage = singleElimination(teams, { thirdPlace: true });
|
|
13
|
+
stage = reportResult(stage, 'main.r1.m1', { scores: [3, 1] });
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
- Single and double elimination, round robin, Swiss, and groups to playoffs
|
|
17
|
+
- Seeding with automatic byes, result propagation, live scores and standings
|
|
18
|
+
- Plain, serialisable data: store a stage, send it, render it anywhere
|
|
19
|
+
- `layoutGroup` for drawing brackets outside React
|
|
20
|
+
|
|
21
|
+
If you use React, install `react-brackets` instead: it re-exports everything here.
|
|
22
|
+
|
|
23
|
+
[Documentation](https://github.com/MohOulabi/react-brackets) · MIT
|