You are here

Home » API reference » Toc.js 2.0.x

toc_js.schema.yml in Toc.js 2.0.x

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

File

config/schema/toc_js.schema.yml
View source 
  1. node.type.*.third_party.toc_js:

  2.   type: mapping

  3.   label: 'Per-content type tocjs node settings'

  4.   mapping:

  5.     toc_js_active:

  6.       type: integer

  7.       label: 'Enable Toc.js for content type'

  8.     title:

  9.       type: label

  10.       label: 'Toc title'

  11.     selectors:

  12.       type: string

  13.       label: 'Elements to use as headings'

  14.     selectors_minimum:

  15.       type: string

  16.       label: 'Set a minimum of elements to display the toc'

  17.     container:

  18.       type: string

  19.       label: 'Element to find all selectors in'

  20.     prefix:

  21.       type: string

  22.       label: 'Prefix for anchor tags and class names'

  23.     list_type:

  24.       type: string

  25.       label: 'The HTML list type to use'

  26.     classes:

  27.       type: string

  28.       label: 'Custom css classes.'

  29.     back_to_top:

  30.       type: integer

  31.       label: 'Add back to top link on heading'

  32.     back_to_top_label:

  33.       type: label

  34.       label: 'Back to top link label'

  35.     smooth_scrolling:

  36.       type: integer

  37.       label: 'Enable or disable smooth scrolling on click'

  38.     scroll_to_offset:

  39.       type: string

  40.       label: 'Offset to trigger with smooth scrolling enabled'

  41.     highlight_on_scroll:

  42.       type: integer

  43.       label: 'Add class to heading that is currently in focus'

  44.     highlight_offset:

  45.       type: string

  46.       label: 'Offset to trigger the next headline'

  47.     sticky:

  48.       type: integer

  49.       label: 'Stick the toc on window scroll'

  50.     sticky_offset:

  51.       type: string

  52.       label: 'The offset to apply when toc is sticky'

  53.     sticky_stop:

  54.       type: string

  55.       label: 'Selector to use as a sticky stop'

  56.     sticky_stop_padding:

  57.       type: string

  58.       label: 'The padding to apply before the sticky stop'

  59. 

  60. block.settings.toc_js_block:

  61.   type: block_settings

  62.   label: 'Toc.js block settings'

  63.   mapping:

  64.     title:

  65.       type: label

  66.       label: 'Toc title'

  67.     selectors:

  68.       type: string

  69.       label: 'Elements to use as headings'

  70.     selectors_minimum:

  71.       type: string

  72.       label: 'Set a minimum of elements to display the toc'

  73.     container:

  74.       type: string

  75.       label: 'Element to find all selectors in'

  76.     prefix:

  77.       type: string

  78.       label: 'Prefix for anchor tags and class names'

  79.     list_type:

  80.       type: string

  81.       label: 'The HTML list type to use'

  82.     classes:

  83.       type: string

  84.       label: 'Custom css classes.'

  85.     back_to_top:

  86.       type: integer

  87.       label: 'Add back to top link on heading'

  88.     back_to_top_label:

  89.       type: label

  90.       label: 'Back to top link label'

  91.     smooth_scrolling:

  92.       type: integer

  93.       label: 'Enable or disable smooth scrolling on click'

  94.     scroll_to_offset:

  95.       type: string

  96.       label: 'Offset to trigger with smooth scrolling enabled'

  97.     highlight_on_scroll:

  98.       type: integer

  99.       label: 'Add class to heading that is currently in focus'

  100.     highlight_offset:

  101.       type: string

  102.       label: 'Offset to trigger the next headline'

  103.     sticky:

  104.       type: integer

  105.       label: 'Stick the toc on window scroll'

  106.     sticky_offset:

  107.       type: string

  108.       label: 'The offset to apply when toc is sticky'

  109.     sticky_stop:

  110.       type: string

  111.       label: 'Selector to use as a sticky stop'

  112.     sticky_stop_padding:

  113.       type: string

  114.       label: 'The padding to apply before the sticky stop'