grapesjs/docs/assets/js/73.ca348e41.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[73],{438:function(e,t,r){"use strict";r.r(t);var a=r(14),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h2",{attrs:{id:"trait"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trait"}},[e._v("#")]),e._v(" Trait")]),e._v(" "),t("h3",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("id")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Trait id, eg. "),t("code",[e._v("my-trait-id")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("type")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Trait type, defines how the trait should be rendered. Possible values: "),t("code",[e._v("text")]),e._v(" (default), "),t("code",[e._v("number")]),e._v(", "),t("code",[e._v("select")]),e._v(", "),t("code",[e._v("checkbox")]),e._v(", "),t("code",[e._v("color")]),e._v(", "),t("code",[e._v("button")])]),e._v(" "),t("li",[t("code",[e._v("label")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" The trait label to show for the rendered trait.")]),e._v(" "),t("li",[t("code",[e._v("name")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" 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 "),t("code",[e._v("changeProp")]),e._v(" in enabled.")]),e._v(" "),t("li",[t("code",[e._v("default")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Default value to use in case the value is not defined on the component.")]),e._v(" "),t("li",[t("code",[e._v("placeholder")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Placeholder to show inside the default input (if the UI type allows it).")]),e._v(" "),t("li",[t("code",[e._v("category")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1),e._v("?")]),e._v(" Trait category.")]),e._v(" "),t("li",[t("code",[e._v("changeProp")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)]),e._v(" If "),t("code",[e._v("true")]),e._v(", the trait value is applied on the component property, otherwise, on component attributes.")])]),e._v(" "),t("h2",{attrs:{id:"getid"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getid"}},[e._v("#")]),e._v(" getId")]),e._v(" "),t("p",[e._v("Get the trait id.")]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"gettype"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#gettype"}},[e._v("#")]),e._v(" getType")]),e._v(" "),t("p",[e._v("Get the trait type.")]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"getname"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getname"}},[e._v("#")]),e._v(" getName")]),e._v(" "),t("p",[e._v("Get the trait name.")]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"getlabel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getlabel"}},[e._v("#")]),e._v(" getLabel")]),e._v(" "),t("p",[e._v("Get the trait label.")]),e._v(" "),t("h3",{attrs:{id:"parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("opts")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Options. (optional, default "),t("code",[e._v("{}")]),e._v(")")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("opts.locale")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)]),e._v(" Use the locale string from i18n module. (optional, default "),t("code",[e._v("true")]),e._v(")")])])])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"getvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getvalue"}},[e._v("#")]),e._v(" getValue")]),e._v(" "),t("p",[e._v("Get the trait value.\nThe value is taken from component attributes by default or from properties if the trait has the "),t("code",[e._v("changeProp")]),e._v(" enabled.")]),e._v(" "),t("h3",{attrs:{id:"parameters-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("opts")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Options. (optional, default "),t("code",[e._v("{}")]),e._v(")")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("opts.useType")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)]),e._v(" Get the value based on type (eg. the checkbox will always return a boolean). (optional, default "),t("code",[e._v("false")]),e._v(")")])])])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[e._v("any")])]),e._v(" "),t("h2",{attrs:{id:"setvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setvalue"}},[e._v("#")]),e._v(" setValue")]),e._v(" "),t("p",[e._v("Update the trait value.\nThe value is applied on component attributes by default or on properties if the trait has the "),t("code",[e._v("changeProp")]),e._v(" enabled.")]),e._v(" "),t("h3",{attrs:{id:"parameters-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("value")]),e._v(" "),t("strong",[e._v("any")]),e._v(" Value of the trait.")])]),e._v(" "),t("li",[t("p",[t("code",[e._v("opts")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Options. (optional, default "),t("code",[e._v("{}")]),e._v(")")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("opts.partial")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1),e._v("?")]),e._v(" If "),t("code",[e._v("true")]),e._v(" the update won't be considered complete (not stored in UndoManager).")])])])]),e._v(" "),t("h2",{attrs:{id:"getdefault"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getdefault"}},[e._v("#")]),e._v(" getDefault")]),e._v(" "),t("p",[e._v("Get default value.")]),e._v(" "),t("h2",{attrs:{id:"getoptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getoptions"}},[e._v("#")]),e._v(" getOptions")]),e._v(" "),t("p",[e._v("Get trait options.")]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array",target:"_blank",rel:"noopener noreferrer"}},[e._v("Array"),t("OutboundLink")],1),e._v("<TraitOption>")])]),e._v(" "),t("h2",{attrs:{id:"getoption"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getoption"}},[e._v("#")]),e._v(" getOption")]),e._v(" "),t("p",[e._v("Get current selected option or by id.")]),e._v(" "),t("h3",{attrs:{id:"parameters-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("id")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1),e._v("?")]),e._v(" Option id.")])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[e._v("("),t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1),e._v(" | null)")])]),e._v(" "),t("h2",{attrs:{id:"getoptionid"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getoptionid"}},[e._v("#")]),e._v(" getOptionId")]),e._v(" "),t("p",[e._v("Get the option id from the option object.")]),e._v(" "),t("h3",{attrs:{id:"parameters-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("option")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Option object")])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Option id")]),e._v(" "),t("h2",{attrs:{id:"getoptionlabel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getoptionlabel"}},[e._v("#")]),e._v(" getOptionLabel")]),e._v(" "),t("p",[e._v("Get option label.")]),e._v(" "),t("h3",{attrs:{id:"parameters-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("id")]),e._v(" "),t("strong",[e._v("("),t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1),e._v(")")]),e._v(" Option id or the option object")])]),e._v(" "),t("li",[t("p",[t("code",[e._v("opts")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Options (optional, default "),t("code",[e._v("{}")]),e._v(")")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("opts.locale")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)]),e._v(" Use the locale string from i18n module (optional, default "),t("code",[e._v("true")]),e._v(")")])])])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)]),e._v(" Option label")]),e._v(" "),t("h2",{attrs:{id:"getcategorylabel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getcategorylabel"}},[e._v("#")]),e._v(" getCategoryLabel")]),e._v(" "),t("p",[e._v("Get category label.")]),e._v(" "),t("h3",{attrs:{id:"parameters-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[e._v("#")]),e._v(" Parameters")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("opts")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object",target:"_blank",rel:"noopener noreferrer"}},[e._v("Object"),t("OutboundLink")],1)]),e._v(" Options. (optional, default "),t("code",[e._v("{}")]),e._v(")")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("opts.locale")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)]),e._v(" Use the locale string from i18n module. (optional, default "),t("code",[e._v("true")]),e._v(")")])])])]),e._v(" "),t("p",[e._v("Returns "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String",target:"_blank",rel:"noopener noreferrer"}},[e._v("String"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"runcommand"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#runcommand"}},[e._v("#")]),e._v(" runCommand")]),e._v(" "),t("p",[e._v("Run the trait command (used on the button trait type).")])])}),[],!1,null,null,null);t.default=o.exports}}]);