Utility Functions

Prop schema factory functions are re-exported from @ptahjs/designer through @ptahjs/ui-vue.

import {
    stringProp,
    numberProp,
    booleanProp,
    selectProp,
    objectProp,
    arrayProp,
    groupProp,
} from '@ptahjs/ui-vue';

Common Fields

Most prop factories accept:

• field
• label
• component
• defaultValue
• tips

numberProp()

Creates a numeric field.

numberProp({
    component: 'PropNumber',
    field: 'width',
    label: 'Width',
    defaultValue: 100,
});

stringProp()

Creates a string field.

booleanProp()

Creates a boolean field.

selectProp()

Creates a select field and supports options.

objectProp()

Creates an object field with nested props.

arrayProp()

Creates an array field.

groupProp()

Creates a visual group and does not write a field into props.