grapesjs/docs/api/trait.md

Trait

Properties

• id String Trait id, eg. my-trait-id.
• type String Trait type, defines how the trait should be rendered. Possible values: text (default), number, select, checkbox, color, button
• label String The trait label to show for the rendered trait.
• name String The name of the trait used as a key for the attribute/property. By default, the name is used as attribute name or property in case changeProp in enabled.
• default String Default value to use in case the value is not defined on the component.
• placeholder String Placeholder to show inside the default input (if the UI type allows it).
• category String? Trait category.
• changeProp Boolean If true, the trait value is applied on the component property, otherwise, on component attributes.

getId

Get the trait id.

Returns String

getType

Get the trait type.

Returns String

getName

Get the trait name.

Returns String

getLabel

Get the trait label.

Parameters

• opts Object Options. (optional, default {})

  • opts.locale Boolean Use the locale string from i18n module. (optional, default true)

Returns String

getValue

Get the trait value. The value is taken from component attributes by default or from properties if the trait has the changeProp enabled.

Parameters

• opts Object Options. (optional, default {})

  • opts.useType Boolean Get the value based on type (eg. the checkbox will always return a boolean). (optional, default false)

Returns any

setValue

Update the trait value. The value is applied on component attributes by default or on properties if the trait has the changeProp enabled.

Parameters

• value any Value of the trait.

• opts Object Options. (optional, default {})

  • opts.partial Boolean? If true the update won't be considered complete (not stored in UndoManager).

getDefault

Get default value.

getOptions

Get trait options.

Returns Array<TraitOption>

getOption

Get current selected option or by id.

Parameters

• id String? Option id.

Returns (Object | null)

getOptionId

Get the option id from the option object.

Parameters

• option Object Option object

Returns String Option id

getOptionLabel

Get option label.

Parameters

• id (String | Object) Option id or the option object

• opts Object Options (optional, default {})

  • opts.locale Boolean Use the locale string from i18n module (optional, default true)

Returns String Option label

getCategoryLabel

Get category label.

Parameters

• opts Object Options. (optional, default {})

  • opts.locale Boolean Use the locale string from i18n module. (optional, default true)

Returns String

runCommand

Run the trait command (used on the button trait type).