Hiyve Components - v1.0.0
    Preparing search index...

    Props for RhythmStaff.

    interface RhythmStaffProps {
        bars: readonly (readonly (NoteValue | null)[])[];
        captions?: readonly (readonly (string | null | undefined)[])[];
        color?: string;
        end?: "bar" | "final";
        gap?: number;
        glyphSize?: number;
        height?: number;
        renderGap?: (bar: number, index: number) => ReactNode;
        signatureSlot?: ReactNode;
        sx?: SxProps<Theme>;
        timeSignature?: `${number}/${number}` | null;
    }
    Index

    Properties

    bars: readonly (readonly (NoteValue | null)[])[]

    The bars left to right, each its note values; null where renderGap draws something else

    captions?: readonly (readonly (string | null | undefined)[])[]

    A small word under each value, bar by bar (under a gap too): a count of beats, say; null leaves one plain

    color?: string
    end?: "bar" | "final"

    How the staff ends: with the final double bar (default), or a plain bar line where the music carries on, on a staff below

    gap?: number

    The gap between values, in theme spacing

    glyphSize?: number

    The width of each note value's glyph, in pixels

    height?: number

    The staff's height in pixels: its one line runs through the middle

    renderGap?: (bar: number, index: number) => ReactNode

    What to draw at a null in a bar

    signatureSlot?: ReactNode
    sx?: SxProps<Theme>
    timeSignature?: `${number}/${number}` | null

    The signature engraved at the start; null draws signatureSlot there instead, or nothing