settings.html
API
The settings.html
API works in conjunction with settings.js
and settings.json
to deliver a customizable experience to the user.
Overview
The settings.html
file will automatically be styled by our custom implementation of Bootstrap 4 so the use of Bootstrap classes is highly encouraged.
settings.html
Skeleton File
Want to see a full example?
You can download a fully working Module Package from our examples repo on GitHub.Requirements
- The first HTML tag must be our custom
settings
tag - There must be exactly 1
form
tag - Inside the
form
tag there must be exactly 1 submitbutton
withtype
set tosubmit
- The following HTML tags are not allowed:
html
,head
,body
(the HTML will be inserted into an existing DOM) - Do not use
script
tags, put any JavaScript insettings.js
You can do pretty much anything else you want. It is important to have a good interface for your end users so take advantage of Bootstrap's easy styling to create a beautiful settings form.