You are here

Home » API reference » GridStack 8

gridstack.schema.yml in GridStack 8

Same filename and directory in other branches
  1. 8.2 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.     customized:

  7.       type: boolean

  8.       label: 'Use customized GridStack library'

  9.     framework:

  10.       type: string

  11.       label: 'Grid framework'

  12.     library:

  13.       type: string

  14.       label: 'Grid library'

  15. 

  16. # The grids.

  17. gridstack_node:

  18.   type: mapping

  19.   label: 'Grid nodes'

  20.   mapping:

  21.     x:

  22.       type: integer

  23.       label: X

  24.     y:

  25.       type: integer

  26.       label: Y

  27.     width:

  28.       type: integer

  29.       label: Width

  30.     height:

  31.       type: integer

  32.       label: Height

  33.     image_style:

  34.       type: string

  35.       label: 'Image style'

  36. 

  37. gridstack_grid:

  38.   type: sequence

  39.   label: Grids

  40.   sequence:

  41.     - type: mapping

  42.       mapping:

  43.         node:

  44.           type: gridstack_node

  45.           label: Nodes

  46.         nested:

  47.           type: string

  48.           label: Nested

  49. 

  50. gridstack_json:

  51.   type: mapping

  52.   label: JSON

  53.   mapping:

  54.     grids:

  55.       type: sequence

  56.       label: Grids

  57.       sequence:

  58.         - type: string

  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.     image_style:

  76.       type: string

  77.       label: 'Image style'

  78.     width:

  79.       type: integer

  80.       label: Width

  81.     grids:

  82.       type: string

  83.       label: Grids

  84.     nested:

  85.       type: string

  86.       label: 'Nested grids'

  87. 

  88. gridstack_breakpoints:

  89.   type: mapping

  90.   label: Breakpoints

  91.   mapping:

  92.     xs:

  93.       type: gridstack_breakpoint

  94.       label: XS

  95.     sm:

  96.       type: gridstack_breakpoint

  97.       label: SM

  98.     md:

  99.       type: gridstack_breakpoint

  100.       label: MD

  101.     lg:

  102.       type: gridstack_breakpoint

  103.       label: LG

  104.     xl:

  105.       type: gridstack_breakpoint

  106.       label: XL

  107. 

  108. # GridStack JS settings managed by UI.

  109. gridstack_optionset:

  110.   type: mapping

  111.   label: 'Options'

  112.   mapping:

  113.     breakpoints:

  114.       type: gridstack_breakpoints

  115.     # @todo: Remove grids for breakpoints.

  116.     grids:

  117.       type: gridstack_grid

  118.     icon:

  119.       type: string

  120.       label: Icon

  121.     type:

  122.       type: string

  123.       label: Type

  124.     use_framework:

  125.       type: boolean

  126.       label: 'Use static Grid framework'

  127.     settings:

  128.       type: mapping

  129.       label: Settings

  130.       mapping:

  131.         alwaysShowResizeHandle:

  132.           type: boolean

  133.           label: 'Always show resize handle'

  134.         auto:

  135.           type: boolean

  136.           label: Auto

  137.         cellHeight:

  138.           type: integer

  139.           label: 'Cell height'

  140.         disableDrag:

  141.           type: boolean

  142.           label: 'Disable drag'

  143.         disableResize:

  144.           type: boolean

  145.           label: 'Disable resize'

  146.         draggable:

  147.           type: boolean

  148.           label: Draggable

  149.         float:

  150.           type: boolean

  151.           label: Float

  152.         # @todo: Remove grids for breakpoints.

  153.         isNested:

  154.           type: boolean

  155.           label: isNested

  156.         minWidth:

  157.           type: integer

  158.           label: 'Min width'

  159.         width:

  160.           type: integer

  161.           label: Width

  162.         height:

  163.           type: integer

  164.           label: Height

  165.         resizable:

  166.           type: boolean

  167.           label: Resizable

  168.         rtl:

  169.           type: boolean

  170.           label: RTL

  171.         staticGrid:

  172.           type: boolean

  173.           label: staticGrid

  174.         verticalMargin:

  175.           type: integer

  176.           label: 'Vertical margin'

  177.         noMargin:

  178.           type: boolean

  179.           label: 'No horizontal margin'

  180. 

  181. # Individual GridStack JS settings managed by UI.

  182. gridstack.optionset.*:

  183.   type: config_entity

  184.   label: 'GridStack optionset'

  185.   mapping:

  186.     id:

  187.       type: string

  188.       label: ID

  189.     name:

  190.       type: string

  191.       label: Name

  192.     weight:

  193.       type: integer

  194.       label: Weight

  195.     label:

  196.       type: label

  197.       label: Label

  198.     uuid:

  199.       type: string

  200.       label: UUID

  201.     json:

  202.       type: gridstack_json

  203.     options:

  204.       type: gridstack_optionset

  205.       label: Options

  206. 

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

  208. gridstack_vanilla:

  209.   type: blazy_base

  210.   label: 'GridStack display format vanilla settings'

  211.   mapping: {}

  212. 

  213. gridstack_base:

  214.   type: blazy_base

  215.   label: 'GridStack display format base settings'

  216.   mapping:

  217.     caption:

  218.       type: sequence

  219.       label: Captions

  220.       sequence:

  221.         - type: string

  222.           label: 'Caption field'

  223.     stamp:

  224.       type: sequence

  225.       label: Stamps

  226.       sequence:

  227.         - type: string

  228. 

  229. field.formatter.settings.gridstack_image:

  230.   type: gridstack_vanilla

  231.   label: 'GridStack Image display format settings'

  232. 

  233. field.formatter.settings.gridstack_file:

  234.   type: gridstack_vanilla

  235.   label: 'GridStack File display format settings'

  236. 

  237. field.formatter.settings.gridstack_media:

  238.   type: gridstack_vanilla

  239.   label: 'GridStack Media display format settings'

  240. 

  241. field.formatter.settings.gridstack_paragraphs:

  242.   type: gridstack_vanilla

  243.   label: 'GridStack Paragraphs display format settings'