Pular para o conteúdo principal

ComponentParameter

Reference

Parameters​

component​

Component data2-core-primitives@String

title​

Component data2-core-primitives@String

category​

Component data2-core-primitives@String

One of 'appearance' | 'content' | 'behaviour' | 'other'

icon​

Component data2-core-primitives@String

description​

Component data2-core-primitives@String

preview​

Component data2-core-types@FileComponentUrlReference

visibility​

Component data2-core-primitives@String

One of 'public' | 'private' | 'deprecated'

index​

Component data2-core-primitives@Number

Component data2-core-primitives@String

strict​

If true, ƒ() suggestions will only suggest matching component types.

Component data2-core-primitives@Boolean

list​

If true, the field is a list.

Component data2-core-primitives@Boolean

multiLine​

If true, the field Control should be multiline.

Component data2-core-primitives@Boolean

simple​

If true, the CustomControl should be simple.

Component data2-core-primitives@Boolean

oneOf
list
​

Component data2-core-primitives@Generic

autocomplete​

Component data2-core-types@Definition

mock​

Component data2-core-primitives@Generic

definition​

Component data2-core-types@Definition

defaultValue​

Component data2-core-types@Definition

expectedPrimitiveTypes
list
​

Component data2-core-primitives@String

One of 'data2-core-primitives@String' | 'data2-core-primitives@Boolean' | 'data2-core-primitives@Number' | 'data2-core-primitives@Object' | 'data2-core-primitives@Function' | 'data2-core-primitives@Undefined' | 'data2-core-primitives@Null' | 'data2-core-primitives@Generic'

required​

If true, the field is required.

Component data2-core-primitives@Boolean

parameters​

Component data2-core-primitives@Object

    arguments
    list
    ​

    Component data2-core-types@ComponentParameter

    async​

    If true, the Function is asynchronous.

    Component data2-core-primitives@Boolean

    pure​

    If true, the Function is pure.

    Component data2-core-primitives@Boolean

    returnPrimitiveTypes
    list
    ​

    Component data2-core-primitives@String

    One of 'data2-core-primitives@String' | 'data2-core-primitives@Boolean' | 'data2-core-primitives@Number' | 'data2-core-primitives@Object' | 'data2-core-primitives@Function' | 'data2-core-primitives@Undefined' | 'data2-core-primitives@Null' | 'data2-core-primitives@Generic'

    fallbackValue​

    Component data2-core-types@Definition

    dependsOn
    list
    ​

    Component data2-core-primitives@String

    shouldShow​

    Component data2-core-primitives@Boolean

    flat​

    If true, the Object should be displayed flattened in Inspector (avoid deep navigation)

    Component data2-core-primitives@Boolean

    componentOptions​

    Component data2-core-primitives@Object

      key​

      Component data2-core-primitives@String

      unversioned​

      Used to show in the Builder inspector if a param isn't versioned, and changes are instantly applied.

      Component data2-core-primitives@Boolean