Documentation
    Preparing search index...

    Module @music-ui/fretboard - v0.16.0

    Music UI - Fretboard

    Simple fretboard diagram generator.

    See documentation

    This project does not accept contributions generated by LLMs (Large Language Models), sometimes also referred to as "AI". This policy is not open to discussion, any content submitted that is clearly labelled as LLM-generated (including issues, merge requests, and merge request descriptions) will be immediately closed, and any attempt to bypass this policy will result in a ban from the project.

    Copyright (c) 2026 Diego Caponera

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    <internal>
    Fretboard
    FretboardSystem
    BareFretboardPosition
    Barre
    BarreInput
    FretboardOptions
    FretboardPosition
    FretboardSystemParams
    InitChordsParams
    ParseChordParams
    Point
    RenderChordParams
    ScaleParams
    StyleParams
    SystemPosition
    Systems
    Tuning
    CHORD_SYMBOLS
    cssClasses
    DEFAULT_CHORD_OPTIONS
    DEFAULT_COLORS
    DEFAULT_DIMENSIONS
    DEFAULT_FONT_FAMILY
    DEFAULT_FONT_SIZE
    DEFAULT_FRET_COUNT
    DEFAULT_FRETBOARD_OPTIONS
    DEFAULT_HIGHLIGHT_BLEND_MODE
    DEFAULT_OPTIONS
    defaultMuteStringsParams
    GUITAR_TUNINGS
    MIDDLE_FRET
    findPositionInArray
    getBox
    getChordFretSpan
    getModeFromScaleType
    highlightDegreeFill
    initChord
    initChords
    initChordsWithPlayer
    parseBarres
    parseChord