primevue-mirror/api-generator/components/knob.js

const KnobProps = [
    {
        name: 'modelValue',
        type: 'number',
        default: 'null',
        description: 'Value of the component.'
    },
    {
        name: 'size',
        type: 'number',
        default: '100',
        description: 'Size of the component in pixels.'
    },
    {
        name: 'disabled',
        type: 'boolean',
        default: 'false',
        description: 'When present, it specifies that the component should be disabled.'
    },
    {
        name: 'readonly',
        type: 'boolean',
        default: 'false',
        description: 'When present, it specifies that the component value cannot be edited.'
    },
    {
        name: 'step',
        type: 'number',
        default: 'null',
        description: 'Step factor to increment/decrement the value.'
    },
    {
        name: 'min',
        type: 'number',
        default: '0',
        description: 'Mininum boundary value.'
    },
    {
        name: 'max',
        type: 'number',
        default: '100',
        description: 'Maximum boundary value.'
    },
    {
        name: 'valueColor',
        type: 'string',
        default: 'null',
        description: 'Background of the value.'
    },
    {
        name: 'rangeColor',
        type: 'string',
        default: 'null',
        description: 'Background color of the range.'
    },
    {
        name: 'textColor',
        type: 'string',
        default: 'null',
        description: 'Color of the value text.'
    },
    {
        name: 'strokeWidth',
        type: 'number',
        default: '14',
        description: 'Width of the knob stroke.'
    },
    {
        name: 'showValue',
        type: 'boolean',
        default: 'true',
        description: 'Whether the show the value inside the knob.'
    },
    {
        name: 'valueTemplate',
        type: 'function | string',
        default: 'val => val',
        description: 'Controls how the knob is labeled.'
    },
    {
        name: 'tabindex',
        type: 'number',
        default: 'null',
        description: 'Index of the element in tabbing order.'
    },
    {
        name: 'aria-labelledby',
        type: 'string',
        default: 'null',
        description: 'Establishes relationships between the component and label(s) where its value should be one or more element IDs.'
    },
    {
        name: 'aria-label',
        type: 'string',
        default: 'null',
        description: 'Used to define a string that labels the element.'
    },
    {
        name: 'pt',
        type: 'any',
        default: 'null',
        description: 'Used to pass attributes to DOM elements inside the component.'
    },
    {
        name: 'unstyled',
        type: 'boolean',
        default: 'false',
        description: 'When enabled, it removes component related styles in the core.'
    }
];

const KnobEvents = [
    {
        name: 'change',
        description: 'Callback to invoke when the value changes.',
        arguments: [
            {
                name: 'value',
                type: 'number',
                description: 'New value'
            }
        ]
    }
];

module.exports = {
    knob: {
        name: 'Knob',
        description: 'Knob is a form component to define number inputs with a dial.',
        props: KnobProps,
        events: KnobEvents
    }
};