You are here

Home » API reference » GridStack 8.2

gridstack.schema.yml in GridStack 8.2

Same filename and directory in other branches
  1. 8 config/schema/gridstack.schema.yml
config/schema/gridstack.schema.yml

File

config/schema/gridstack.schema.yml
View source 
  1. # Schema for the configuration files of the GridStack module.

  2. gridstack.settings:

  3.   type: config_object

  4.   label: 'GridStack settings'

  5.   mapping:

  6.     framework:

  7.       type: string

  8.       label: 'Grid framework'

  9.     fw_classes:

  10.       type: string

  11.       label: 'Framework classes'

  12.     no_classes:

  13.       type: boolean

  14.       label: 'No classes'

  15.     library:

  16.       type: string

  17.       label: 'Grid library'

  18.     dev:

  19.       type: boolean

  20.       label: 'Use non-minified GridStack library'

  21.     debug:

  22.       type: boolean

  23.       label: Debug

  24.     optimized:

  25.       type: boolean

  26.       label: Optimized

  27.     palettes:

  28.       type: string

  29.       label: 'Color palettes'

  30.     palettes_pos:

  31.       type: string

  32.       label: 'Palettes position'

  33.     excludes:

  34.       type: string

  35.       label: 'Exclude optionsets'

  36.     html5_ac:

  37.       type: boolean

  38.       label: 'Use HTML5 autocomplete'

  39.     gridstatic:

  40.       type: boolean

  41.       label: 'Use minimal GridStack'

  42.     helpless:

  43.       type: boolean

  44.       label: 'Remove Help section'

  45.     skinless:

  46.       type: boolean

  47.       label: 'Remove Skin option'

  48.     animationless:

  49.       type: boolean

  50.       label: 'Remove Animation option'

  51.     editor_pos:

  52.       type: string

  53.       label: 'Layout editor position'

  54. 

  55. gridstack_json:

  56.   type: mapping

  57.   label: JSON

  58.   mapping:

  59.     settings:

  60.       type: string

  61.       label: Settings

  62.     breakpoints:

  63.       type: string

  64.       label: Breakpoints

  65. 

  66. gridstack_breakpoint:

  67.   type: mapping

  68.   mapping:

  69.     breakpoint:

  70.       type: string

  71.       label: Breakpoint

  72.     column:

  73.       type: integer

  74.       label: Column

  75.     width:

  76.       type: integer

  77.       label: Width

  78.     grids:

  79.       type: string

  80.       label: Grids

  81.     nested:

  82.       type: string

  83.       label: 'Nested grids'

  84. 

  85. gridstack_breakpoints:

  86.   type: mapping

  87.   label: Breakpoints

  88.   mapping:

  89.     xs:

  90.       type: gridstack_breakpoint

  91.       label: XS

  92.     sm:

  93.       type: gridstack_breakpoint

  94.       label: SM

  95.     md:

  96.       type: gridstack_breakpoint

  97.       label: MD

  98.     lg:

  99.       type: gridstack_breakpoint

  100.       label: LG

  101.     xl:

  102.       type: gridstack_breakpoint

  103.       label: XL

  104. 

  105. # GridStack JS settings managed by UI.

  106. gridstack_optionset:

  107.   type: mapping

  108.   label: 'Options'

  109.   mapping:

  110.     breakpoints:

  111.       type: gridstack_breakpoints

  112.     icon:

  113.       type: string

  114.       label: Icon

  115.     type:

  116.       type: string

  117.       label: Type

  118.     use_framework:

  119.       type: boolean

  120.       label: 'Use static Grid framework'

  121.     settings:

  122.       type: mapping

  123.       label: Settings

  124.       mapping:

  125.         auto:

  126.           type: boolean

  127.           label: Auto

  128.         cellHeight:

  129.           type: integer

  130.           label: 'Cell height'

  131.         float:

  132.           type: boolean

  133.           label: Float

  134.         minWidth:

  135.           type: integer

  136.           label: 'Min width'

  137.         rtl:

  138.           type: boolean

  139.           label: RTL

  140.         verticalMargin:

  141.           type: integer

  142.           label: 'Vertical margin'

  143.         noMargin:

  144.           type: boolean

  145.           label: 'No horizontal margin'

  146.         # Introduced at v0.5.3.

  147.         column:

  148.           type: integer

  149.           label: 'Amount of columns'

  150.         maxRow:

  151.           type: integer

  152.           label: 'Maximum rows'

  153. 

  154. # Individual GridStack JS settings managed by UI.

  155. gridstack.optionset.*:

  156.   type: config_entity

  157.   label: 'GridStack optionset'

  158.   mapping:

  159.     id:

  160.       type: string

  161.       label: ID

  162.     name:

  163.       type: string

  164.       label: Name

  165.     weight:

  166.       type: integer

  167.       label: Weight

  168.     label:

  169.       type: label

  170.       label: Label

  171.     uuid:

  172.       type: string

  173.       label: UUID

  174.     description:

  175.       type: string

  176.       label: Description

  177.     json:

  178.       type: gridstack_json

  179.     options:

  180.       type: gridstack_optionset

  181.       label: Options

  182. 

  183. # Individual GridStack variant settings managed by UI.

  184. gridstack.variant.*:

  185.   type: config_entity

  186.   label: 'GridStack optionset'

  187.   mapping:

  188.     id:

  189.       type: string

  190.       label: ID

  191.     name:

  192.       type: string

  193.       label: Name

  194.     weight:

  195.       type: integer

  196.       label: Weight

  197.     label:

  198.       type: label

  199.       label: Label

  200.     uuid:

  201.       type: string

  202.       label: UUID

  203.     description:

  204.       type: string

  205.       label: Description

  206.     source:

  207.       type: string

  208.       label: Source

  209.     options:

  210.       type: mapping

  211.       label: Options

  212.       mapping:

  213.         breakpoints:

  214.           type: gridstack_breakpoints

  215.         icon:

  216.           type: string

  217.           label: Icon

  218. 

  219. # HTML content/layout-related settings managed by GridStack plugins.

  220. gridstack_vanilla:

  221.   type: blazy_base

  222.   label: 'GridStack display format vanilla settings'

  223.   mapping: {}

  224. 

  225. gridstack_base:

  226.   type: blazy_base

  227.   label: 'GridStack display format base settings'

  228.   mapping:

  229.     caption:

  230.       type: sequence

  231.       label: Captions

  232.       sequence:

  233.         - type: string

  234.           label: 'Caption field'

  235.     stamp:

  236.       type: sequence

  237.       label: Stamps

  238.       sequence:

  239.         - type: string

  240. 

  241. field.formatter.settings.gridstack_image:

  242.   type: gridstack_vanilla

  243.   label: 'GridStack Image display format settings'

  244. 

  245. field.formatter.settings.gridstack_file:

  246.   type: gridstack_vanilla

  247.   label: 'GridStack File display format settings'

  248. 

  249. field.formatter.settings.gridstack_media:

  250.   type: gridstack_vanilla

  251.   label: 'GridStack Media display format settings'

  252. 

  253. field.formatter.settings.gridstack_paragraphs:

  254.   type: gridstack_vanilla

  255.   label: 'GridStack Paragraphs display format settings'