Skip to content

Latest commit

 

History

History
132 lines (91 loc) · 3.68 KB

_pages_section_d_.section.md

File metadata and controls

132 lines (91 loc) · 3.68 KB

ReferenceSmartAppPageSection

Section

A section is a labeled collection of settings. The contents can be made collapsible if desired. To create a basic non-collapsible section:

page.section('section1', section => {
    // create settings here, e.g
    section.booleanSetting('turnBackOn')
}

To make this section collapsible (and initially collapsed):

page.section('section1', section => {
    section.hideable(true).hidden(true)

    // create settings here, e.g
    section.booleanSetting('turnBackOn')
}

Section Options

Setting Methods

defaultRequired

defaultRequired(defaultRequired: boolean): Section

Specifies that all settings in the session should default to being required

Parameters:

Name Type
defaultRequired boolean

Returns: Section


hidden

hidden(value: boolean): Section

Specifies that the section should initially be hidden

Parameters:

Name Type
value boolean

Returns: Section


hideable

hideable(value: boolean): Section

Specifies that the section should be able to be hidden (though not initially hidden)

Parameters:

Name Type
value boolean

Returns: Section


name

name(value: string): Section

Sets the name (label) of the section. Normally not set if the i18n framework is being used

Parameters:

Name Type
value string

Returns: Section


style

style(style: SectionStyle): Section

Sets the session style

Parameters:

Name Type
style SectionStyle

Returns: Section