@tspro/web-music-score 1.1.0 → 2.0.0

package/dist/react-ui/index.d.ts

@@ -0,0 +1,169 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { c as Scale, S as ScaleType } from '../tempo--588tdcv.js';
+import { b as PitchNotation, G as GuitarNoteLabel, N as Note } from '../note-B5ZtlHc8.js';
+import { H as Handedness } from '../guitar-BIFwFT31.js';
+import { DivRect, MDocument, ScoreEventListener, MRenderer, MPlaybackButtons } from '../score/index.js';
+import '@tspro/ts-utils-lib';
+
+/** @public */
+interface CircleOfFifthsProps {
+    style?: React.CSSProperties;
+    scale: Scale;
+    onScaleChange: (scale: Scale) => void;
+}
+/** @public */
+declare class CircleOfFifths extends React.Component<CircleOfFifthsProps, {}> {
+    constructor(props: CircleOfFifthsProps);
+    onScaleChange(tonic: string, scaleType: ScaleType): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+/** @public */
+declare class FretPosition {
+    readonly guitarCtx: GuitarContext;
+    readonly stringId: number;
+    readonly fretId: number;
+    readonly chromaticId: number;
+    readonly note: Note;
+    readonly isScaleNote: boolean;
+    readonly isScaleRootNote: boolean;
+    isVisible: boolean;
+    text: string;
+    textColor: string;
+    fillColor: string | undefined;
+    borderColor: string | undefined;
+    isBarre: boolean;
+    constructor(guitarCtx: GuitarContext, stringId: number, fretId: number, chromaticId: number);
+    get chromaticClass(): number;
+    show(): void;
+    hide(): void;
+    setDefaultText(): void;
+    setDefaultFillColor(): void;
+    setDefaultBorderColor(showBorder?: boolean): void;
+}
+/** @public */
+declare class GuitarContext {
+    readonly tuningName: string;
+    readonly scale: Scale;
+    readonly handedness: Handedness;
+    readonly pitchNotation: PitchNotation;
+    readonly guitarNoteLabel: GuitarNoteLabel;
+    readonly maxFretId: number;
+    private readonly fretPositionTable;
+    private readonly tuningStrings;
+    constructor(tuningName: string, scale: Scale, handedness: Handedness, pitchNotation: PitchNotation, guitarNoteLabel: GuitarNoteLabel);
+    getFretPosition(stringId: number, fretId: number): Readonly<FretPosition>;
+    getStringTuning(stringId: number): Note;
+    getTuningOverview(): string;
+    alterTuningName(tuningName: string): GuitarContext;
+    alterScale(scale: Scale): GuitarContext;
+    alterHandedness(handedness: Handedness): GuitarContext;
+    alterPitchNotation(pitchNotation: PitchNotation): GuitarContext;
+    alterGuitarNoteLabel(guitarNoteLabel: GuitarNoteLabel): GuitarContext;
+}
+
+/** @public */
+declare class FretPositionData {
+    readonly fretPosition: Readonly<FretPosition>;
+    readonly cellRect: DivRect;
+    readonly noteRect: DivRect;
+    constructor(fretPosition: Readonly<FretPosition>, cellRect: DivRect, noteRect: DivRect);
+}
+/** @public  */
+type UpdateFretPositionFunc = (fretPosition: FretPosition) => void;
+/** @public  */
+type ClickFretPositionFunc = (fretPosition: FretPosition) => void;
+/** @public */
+interface GuitarViewProps {
+    style?: React.CSSProperties;
+    guitarContext: GuitarContext;
+    onUpdateFretPosition?: UpdateFretPositionFunc;
+    onClickFretPosition?: ClickFretPositionFunc;
+}
+/** @public */
+interface GuitarViewState {
+    width: number;
+    height: number;
+    table: FretPositionData[][];
+}
+/** @public */
+declare class GuitarView extends React.Component<GuitarViewProps, GuitarViewState> {
+    state: GuitarViewState;
+    constructor(props: GuitarViewProps);
+    componentDidUpdate(prevProps: GuitarViewProps): void;
+    getLayoutState(): {
+        table: FretPositionData[][];
+        width: number;
+        height: number;
+    };
+    onHover(fretPositionData?: FretPositionData): void;
+    onClick(fretPositionData?: FretPositionData): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+/** @public */
+interface MusicScoreViewProps {
+    doc: MDocument;
+    onScoreEvent?: ScoreEventListener;
+}
+/**
+ * @public
+ *
+ * Usage:
+ *
+ *  import * as Score from "\@tspro/web-music-score";
+ *
+ *  \<Score.MusicScoreView doc=\{doc\} /\>
+ */
+declare class MusicScoreView extends React.Component<MusicScoreViewProps, {}> {
+    renderer: MRenderer;
+    constructor(props: MusicScoreViewProps);
+    componentDidUpdate(prevProps: Readonly<MusicScoreViewProps>, prevState: Readonly<{}>): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+/** @public */
+declare enum PlaybackButtonsLayout {
+    PlayStopSingle = 0,
+    PlayStop = 1,
+    PlayPauseStop = 2
+}
+/** @public */
+interface PlaybackButtonsProps {
+    doc: MDocument;
+    buttonLayout?: PlaybackButtonsLayout;
+    playLabel?: string;
+    pauseLabel?: string;
+    stopLabel?: string;
+}
+/** @public */
+interface PlaybackButtonsState {
+    controller: MPlaybackButtons;
+}
+/**
+ * @public
+ *
+ * Usage:
+ *
+ *  import * as Score from "\@tspro/web-music-score";
+ *
+ *  \<Score.PlaybackButtons doc=\{doc\} /\>
+ *
+ * To set custom play, pause and stop labels:
+ *
+ *  \<Score.PlaybackButtons doc=\{doc\} playLabel="⏵" pauseLabel="⏸" stopLabel="⏹" /\>
+ *
+ * To use different button layout.
+ *
+ *  \<Score.PlaybackButtons doc=\{doc\} buttonLayout=\{Score.PlaybackButtonsLayout.PlayStopSingle\} /\>
+ *
+ */
+declare class PlaybackButtons extends React.Component<PlaybackButtonsProps, PlaybackButtonsState> {
+    state: PlaybackButtonsState;
+    constructor(props: PlaybackButtonsProps);
+    componentDidUpdate(prevProps: Readonly<PlaybackButtonsProps>): void;
+    render(): react_jsx_runtime.JSX.Element;
+}
+
+export { CircleOfFifths, type CircleOfFifthsProps, type ClickFretPositionFunc, FretPosition, FretPositionData, GuitarContext, GuitarView, type GuitarViewProps, type GuitarViewState, MusicScoreView, type MusicScoreViewProps, PlaybackButtons, PlaybackButtonsLayout, type PlaybackButtonsProps, type PlaybackButtonsState, type UpdateFretPositionFunc };