API-ul JavaScript Divi Builder

API-ul JavaScript Divi Builder

API-ul JavaScript Divi Builder – Definiția API JavaScript a constructorului.

window : Window

Obiect window global.

Tip: global typedef
Emite: event:et_builder_api_ready

ETBuilderModule : React.Component | object

Modul personalizat pentru Divi Builder.

Tip: global typedef

Proprietăți Statice (Obligatoriu)

Metode (Obligatoriu)

API

Obiectul API Divi Builder a fost transmis la apelurile inverse înregistrate ale evenimentului eveniment:et_builder_api_ready.

Tip: constantă globală

• API
  • .Modules
    • .register(modules)
  • .Utils
    • ._()
    • .classnames() ⇒ string
    • .decodeOptionListValue(encoded_value) ⇒ object
    • .fontnameToClass(font_name) ⇒ string
    • .linkRel(saved_value) ⇒ string
    • .maybeLoadFont(font_name)
    • .processFontIcon(icon, is_down_icon) ⇒ string
    • .setElementFont(font_data, use_important, default_values) ⇒ string
    • .hasValue(value) ⇒ boolean
    • .generateStyles(moduleArgs) ⇒ array
  • .isRegistered(slug) ⇒ boolean
  • .registerModules(modules)

API.Module

Gestionați module personalizate.

Tip: proprietate statică a API
Din: 3.1

Modules.register(module)

Înregistrați unul sau mai multe module personalizate.

Tip: metoda statică a Modules
Din: 3.1

API.Utils

Funcții utile

Tip: proprietate statică a API
Din: 3.1

• .Utils
  • ._()
  • .classnames() ⇒ string
  • .decodeOptionListValue(encoded_value) ⇒ object
  • .fontnameToClass(font_name) ⇒ string
  • .linkRel(saved_value) ⇒ string
  • .maybeLoadFont(font_name)
  • .processFontIcon(icon, is_down_icon) ⇒ string
  • .setElementFont(font_data, use_important, default_values) ⇒ string
  • .hasValue(value) ⇒ boolean
  • .generateStyles(moduleArgs) ⇒ array

Utils._()

Lodash – O bibliotecă modernă de utilitate JavaScript care oferă modularitate, performanță și extra.

Tip: metoda statica a Utils
Link: https://github.com/lodash/lodash
Licență: MIT
Copyright: JS Foundation și alți colaboratori https://js.foundation/

Utils.classnames() ⇒ string

Generează valoarea className pe baza argumentelor furnizate. Preia orice număr de argumente care pot fi un șir sau un obiect. Argumentul foo este prescurtare pentru { foo: true }. Dacă valoarea asociată cu o anumită cheie este falsă, cheia nu va fi inclusă în rezultat.

Tip: metoda statica a Utils
Link: https://github.com/JedWatson/classnames
Licență: MIT
Copyright: 2017 Jed Watson

Tip

string | Object.<string, boolean>

Exemple

classNames(‘foo’, ‘bar’);                 // => ‘foo bar’
classNames(‘foo’, { bar: true });         // => ‘foo bar’
classNames({ ‘foo-bar’: true });          // => ‘foo-bar’
classNames({ ‘foo-bar’: false });         // => ”
classNames({ foo: true }, { bar: true }); // => ‘foo bar’
classNames({ foo: true, bar: true });     // => ‘foo bar’

Utils.decodeOptionListValue(encoded_value) ⇒ object

Valoarea șirului de decodare a tipului câmpului de setare a modulului opțiune_list.

Tip: metoda statica a Utils
Din: 3.1

Utils.fontnameToClass(font_name) ⇒ string

Returnează clasa CSS pentru un font Google.

Tip: metoda statică a Utils
De cand??:

Utils.linkRel(saved_value) ⇒ string

Generați valoarea atributului HTML al linkului pe baza unei valori salvate în setările unui modul.

Tip: metoda statica a Utils
Din: 3.1

Utils.maybeLoadFont(nume_font)

Încarcă un font Google dacă nu a fost încă încărcat.

Tip: metoda statica a Utils
Din: 3.1

Utils.processFontIcon(pictogramă, is_down_icon) ⇒ string

Generează HTML pentru o valoare de pictogramă salvată bazată pe font.

Tip: metoda statica a Utils
Din: 3.1

Utils.setElementFont(font_data, use_important, default_values) ⇒ string

Generează proprietăți de stil CSS legate de font din datele fontului salvate în setările unui modul.

Tip: metoda statica a Utils
Din: 3.1

Utils.hasValue(valoare) ⇒ boolean

Verificați dacă valoarea dată poate fi imprimată sau nu (string). Inițial, o modalitate mai simplă de a verifica împotriva șirului gol, dar mai târziu au fost adăugate și mai multe verificări pentru a evita repetarea inutilă. O valoare considerată goală dacă:

• este un șir gol
• este nedefinit
• este fals
• este NaN

Tip: metoda statica a Utils
Din: 4.14.9

Utils.generateStyles(moduleArgs) ⇒ array

Utilizați `Responsive.generateResponsiveCSS` cu plus pentru a genera stiluri de stare lipicioasă dacă modulul îl activează.

Tip: metoda statica a Utils
Din: 4.17.5

Exemple:

/**
* Module arguments.
*
* @typedef moduleArgs
* @type {Object}
* @property {string} address: ''
* @property {Object} attrs: {}
* @property {string} name: ''
* @property {string} defaultValue: ''
* @property {string} type: ''
* @property {boolean} forceReturn: false
* @property {string} selector: '%%order_class%%'
* @property {string} cssProperty: ''
* @property {boolean} important: false
* @property {boolean} hover: true
* @property {boolean} sticky: true
* @property {boolean} responsive: true
* @property {null|boolean} isStickyModule: null
* @property {string} stickyPseudoSelectorLocation: 'order_class'
*/

/**
* Hello World module inline styling.
*
* @param {Object} props Module attribute names and values.
* @param {Object} moduleInfo Module info.
*
* @return array
*/
static css(props, moduleInfo) {
const additionalCSS = [];
const {
generateStyles,
} = window.ET_Builder.API.Utils;

/**
* Box colors arguments.
*
* @var {moduleArgs}
*/
const boxColorsArgs = {
attrs: props,
name: 'box_color',
selector: '%%order_class%% .smpl-hello-world-box-area',
cssProperty: 'background-color',
};
const boxColors = generateStyles(boxColorsArgs);

/**
* boxColors output:
*
* [
* {
* selector: '%%order_class%% .smpl-hello-world-box-area',
* declaration: 'background-color: red;',
* device: 'desktop', // desktop, tablet, phone
* }
* ]
*/
additionalCSS.push(boxColors);

return additionalCSS;
}

API.isRegistered(slug) ⇒ boolean

Indiferent dacă o componentă este înregistrată sau nu.

Tip: metoda statică a API
Din: 3.1

API.registerModules(module)

Ambalaj comod pentru înregistrare

Tip: metoda statică a API
Din: 3.1