-
Notifications
You must be signed in to change notification settings - Fork 0
Cell field options
Martin Leopold edited this page Nov 27, 2013
·
33 revisions
Cells can be configured through fields in the backend. Some fields are required, some are optional. Below is a list of the currently known fields.
cell type | field name | optional? | expects | info |
---|---|---|---|---|
any | title | optional | text | overrides the title |
any | description | optional | text | overrides the description |
any | css-XXX | optional | css | one CSS attribute, like css-background-color = #ff0044 . It will be added to the style of the cell element itself. The "css-" at the beginning is a marker for the system that is needed! |
any | class | optional | class-name(s) | add one or more css classes to a cell. use class names separated by spaces. See "Cell Classes" table below |
any | path | optional | path name | enables named cell links using the set link cell or by using an url like: #/set/<set-path>/<cell-path>. this will open the set and scroll to the specified cell |
set_link | set-id | this or cell-id (or both) required | string or 0 | the ID of the set in the backend or the path set in the backend. if this is omitted or 0, a cell-id is required instead. |
set_link | cell-id | this or set-id (or both) required | string | the ID of the cell (visible in the backend) to link to or the path set via the cell's path field. To link to another cell in the same set, the set-id field can be omitted or set to 0 |
text | text-content | optional | text | the text to display in this cell. HTML will be removed |
html | html-content | optional | html | the HTML code to be inserted into this cell |
iframe | iframe-src | required | url | the URL for the iframe content. "{{baseUrl}}" is a placeholder for the base URL of the score system (from it's config.js setting) |
iframe | attr-XXX | optional | optional attribute value | add attributes (e.g. allowfullscreen) to the iframe tag like so: XXX="attribute value" |
vimeo | vimeo-id | required | int | the Vimeo ID of the video to display |
vimeo | autoplay | optional | "true" or "1" | automatically play the video as soon as it's loaded |
vimeo | loop | optional | "true" or "1" | automatically restart the video when it finishes |
vimeo | on-finish | optional | cell-id | when the video finishes, trigger the one with the given cell-id |
iframe / vimeo | autoload | optional | "true" or "1" | the cell will automatically load it's content when it becomes visible |
iframe / vimeo | sticky | optional | "true" or "1" | the cell will remain loaded if scrolled out of view |
iframe / vimeo | solo | optional | number | add the cell to a numbered "solo-group". only one cell can be open per group. when clicking a cell, all other cells in the same solo-group are closed. |
Cell Classes
Classes to add to a cell's "class" field. You can add multiple classes by separating them with spaces.
cell type | class name | info |
---|---|---|
text, html | text-dark | use a dark text style instead of light |
image, set_link, iframe, vimeo | hide-info | permanently hide the info card (i.e. title and description overlay) |
image, set_link, iframe, vimeo | show-info | permanently show the info card |
image, set_link, iframe, vimeo | hide-description | hide description part of info card |
iframe | click-through | don't capture mouse events. makes it possible to (partially) overlay an iframe but not break interaction with the underlying content |
any | hide-background | hide the background image of a cell. Same as setting "css-background-image" to "none" |
iframe, vimeo | no-loading-ani | don't display loading animation when opening the cell |
any | no-ui | don't display in-set navigation UI when hovering over this cell. can be useful e.g. for cells near the bottom that require mouse interaction |