grapesjs/docs/assets/js/61.f4e5be3d.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[61],{423: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:"property"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#property"}},[e._v("#")]),e._v(" Property")]),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(" Property id, eg. "),t("code",[e._v("my-property-id")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("property")]),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(" Related CSS property name, eg. "),t("code",[e._v("text-align")]),e._v(".")]),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(" Defaul value of the property.")]),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(" Label to use in UI, eg. "),t("code",[e._v("Text Align")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("onChange")]),e._v(" "),t("strong",[t("a",{attrs:{href:"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function",target:"_blank",rel:"noopener noreferrer"}},[e._v("Function"),t("OutboundLink")],1),e._v("?")]),e._v(" Change callback."),t("div",{staticClass:"language-js extra-class"},[t("pre",{pre:!0,attrs:{class:"language-js"}},[t("code",[e._v(" "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("onChange")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" property"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" from"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" to "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=>")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n   console"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("log")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token template-string"}},[t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("Changed property")]),t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")])]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" property"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("getName")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" from"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" to "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])])])]),e._v(" "),t("h3",{attrs:{id:"getid"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getid"}},[e._v("#")]),e._v(" getId")]),e._v(" "),t("p",[e._v("Get property 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("h3",{attrs:{id:"gettype"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#gettype"}},[e._v("#")]),e._v(" getType")]),e._v(" "),t("p",[e._v("Get the property type.\nThe type of the property is defined on property creation and based on its value the proper Property class is assigned.\nThe default type is "),t("code",[e._v("base")]),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("h3",{attrs:{id:"getname"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getname"}},[e._v("#")]),e._v(" getName")]),e._v(" "),t("p",[e._v("Get name (the CSS property 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("h3",{attrs:{id:"getlabel"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getlabel"}},[e._v("#")]),e._v(" getLabel")]),e._v(" "),t("p",[e._v("Get property label.")]),e._v(" "),t("h4",{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("h3",{attrs:{id:"getvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getvalue"}},[e._v("#")]),e._v(" getValue")]),e._v(" "),t("p",[e._v("Get property value.")]),e._v(" "),t("h4",{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.noDefault")]),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(" Avoid returning the default value (optional, default "),t("code",[e._v("false")]),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("h3",{attrs:{id:"hasvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[e._v("#")]),e._v(" hasValue")]),e._v(" "),t("p",[e._v("Check if the property has value.")]),e._v(" "),t("h4",{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("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.noParent")]),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(" Ignore the value if it comes from the parent target. (optional, default "),t("code",[e._v("false")]),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/Boolean",target:"_blank",rel:"noopener noreferrer"}},[e._v("Boolean"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"hasvalueparent"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hasvalueparent"}},[e._v("#")]),e._v(" hasValueParent")]),e._v(" "),t("p",[e._v("Indicates if the current value is coming from a parent target (eg. another CSSRule).")]),e._v(" "),t("p",[e._v("Returns "),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(" "),t("h3",{attrs:{id:"getstyle"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getstyle"}},[e._v("#")]),e._v(" getStyle")]),e._v(" "),t("p",[e._v("Get the CSS style object of the property.")]),e._v(" "),t("h4",{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("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.camelCase")]),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(" Return property name in camelCase.")])])])]),e._v(" "),t("h4",{attrs:{id:"examples"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[e._v("#")]),e._v(" Examples")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// In case the property is `color` with a value of `red`.")]),e._v("\nconsole"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("log")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("property"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("getStyle")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// { color: 'red' };")]),e._v("\n")])])]),t("p",[e._v("Returns "),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(" "),t("h3",{attrs:{id:"getdefaultvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getdefaultvalue"}},[e._v("#")]),e._v(" getDefaultValue")]),e._v(" "),t("p",[e._v("Get the default value.")]),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("h3",{attrs:{id:"upvalue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#upvalue"}},[e._v("#")]),e._v(" upValue")]),e._v(" "),t("p",[e._v("Update the value.\nThe change is also propagated to the selected targets (eg. CSS rule).")]),e._v(" "),t("h4",{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("p",[t("code",[e._v("value")]),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(" New value")])]),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(" If "),t("code",[e._v("true")]),e._v(" the update on targets won't be considered complete (not stored in UndoManager) (optional, default "),t("code",[e._v("false")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("opts.noTarget")]),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 change won't be propagated to selected targets. (optional, default "),t("code",[e._v("false")]),e._v(")")])])])]),e._v(" "),t("h3",{attrs:{id:"isvisible"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#isvisible"}},[e._v("#")]),e._v(" isVisible")]),e._v(" "),t("p",[e._v("Check if the property is visible")]),e._v(" "),t("p",[e._v("Returns "),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(" "),t("h3",{attrs:{id:"clear"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clear"}},[e._v("#")]),e._v(" clear")]),e._v(" "),t("p",[e._v("Clear the value.\nThe change is also propagated to the selected targets (eg. the css property is cleared).")]),e._v(" "),t("h4",{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("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.noTarget")]),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 change won't be propagated to selected targets. (optional, default "),t("code",[e._v("false")]),e._v(")")])])])]),e._v(" "),t("h3",{attrs:{id:"canclear"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#canclear"}},[e._v("#")]),e._v(" canClear")]),e._v(" "),t("p",[e._v("Indicates if the current value comes directly from the selected target and so can be cleared.")]),e._v(" "),t("p",[e._v("Returns "),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(" "),t("h3",{attrs:{id:"getparent"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#getparent"}},[e._v("#")]),e._v(" getParent")]),e._v(" "),t("p",[e._v("If the current property is a sub-property, this will return the parent Property.")]),e._v(" "),t("p",[e._v("Returns "),t("strong",[e._v("(["),t("a",{attrs:{href:"#property"}},[e._v("Property")]),e._v("] | null)")])]),e._v(" "),t("h3",{attrs:{id:"isfull"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#isfull"}},[e._v("#")]),e._v(" isFull")]),e._v(" "),t("p",[e._v("Indicates if the property is full-width in UI.")]),e._v(" "),t("p",[e._v("Returns "),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)])])])}),[],!1,null,null,null);t.default=o.exports}}]);