Skip to the content

Korokoroコロコロ

Roll mixed dice or type notation, compare exact probabilities, keep a history and replay seeded rolls.

Korokoro describes something small rolling in Japanese. About the name

Contents

Reference · React components

DiceRollerfunction

The tray as a React component: <DiceRoller wide notation="2d20kh1+5" />.

A thin wrapper. The tray is plain DOM, mounted into this component's own element once the browser has it and taken back on unmount, so it renders nothing on the server and needs no provider. Options are read when it mounts (and again when locale changes); give it a new key to start over with different ones. notation is followed as it changes, and onRoll is always the newest one passed.

Import it

import { DiceRoller } from "@johnmorrisdotca/korokoro/react";

Definition

function DiceRoller(props: DiceRollerProps): React.JSX.Element

Parameters

NameTypeDescription
propsDiceRollerProps

Component properties, including notation, tray options and host attributes.

Returns

React.JSX.Element

A React host element; the tray is mounted when the component reaches the browser.

Examples

import { createElement } from "react";
import { DiceRoller } from "@johnmorrisdotca/korokoro/react";
const element = createElement(DiceRoller, { notation: "2d6" });
console.log(element.type === DiceRoller);
true

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/korokoro 1.16.0.