regionTemplate - APEXlang Reference

`regionTemplate`

Parent: theme

Children: slot, templateOption

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 The display name of this template.
`templateClass`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `borderlessRegion` `bracketedRegion` `breadcrumbRegion` `buttonRegionWithTitle` `buttonRegionWithoutTitle` `chartRegion` `formRegion` `hideAndShowRegion` `listRegionWithIcon` `navigationRegion` `navigationRegionAlternative1` `regionWithoutButtonsAndTitle` `regionWithoutTitle` `reportFilterMultiRow` `reportFilterSingleRow` `reportsRegion` `reportsRegion100Width` `reportsRegionAlternative1` `sidebarRegion` `sidebarRegionAlternative1` `wizardRegion` `wizardRegionWithIcon` `custom1` `custom2` `custom3` `custom4` `custom5` `custom6` `custom7` `custom8`

Property Groups:

templateOptions

Property	Type	Required	Default Value	Details
`preset`	`array of strings`	No		data type=`string`; lov=`TEMPLATE_OPTIONS`
`default`	`array of strings`	No		data type=`string`; lov=`TEMPLATE_OPTIONS`

templateOptions {
  preset: [
    value
    value
  ]
  default: [
    value
    value
  ]
}

region

Property	Type	Required	Details
`template`	`multiline string`	No	data type=`multiline string`; maxLen=32767
`image`	`multiline string`	No	data type=`multiline string`; maxLen=32767
`htmlTableAttributes`	`string`	No	data type=`string`; maxLen=255

region {
  template: ```html
    value
  ```
  image: ```html
    value
  ```
  htmlTableAttributes: value
}

subRegions

Property	Type	Required	Details
`template`	`multiline string`	No	data type=`multiline string`; maxLen=32767
`header`	`multiline string`	No	data type=`multiline string`; maxLen=32767
`headerEntry`	`multiline string`	No	data type=`multiline string`; maxLen=32767

subRegions {
  template: ```html
    value
  ```
  header: ```html
    value
  ```
  headerEntry: ```html
    value
  ```
}

accessibility

Property	Type	Required	Default Value	Details
`landmarkType`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `banner` `complementary` `contentInfo` `form` `main` `navigation` `region` `search` Define the default landmark type to be used for this region template. When this region template is used by a region, this will be the landmark type exposed to screen reader users, unless this has been overridden at region level. Note: In order for this functionality to work, the Template attribute must include the `#REGION_LANDMARK_ATTRIBUTES#` substitution string. This should be defined on the main container element of the template. Landmarks provide a powerful way to identify the organization and structure of a web page. The structural information conveyed visually to users should be represented programmatically in the markup using landmark roles. The use of landmarks roles support keyboard navigation to the structure of a web page for screen reader users, and can be used as targets for browser extensions for enhanced keyboard navigation. The W3C ARIA Landmarks site provides useful information, including a good reference implementation (click on the 'Show Landmarks' button to visualise well defined landmarks).
`regionTitleHtmlId`	`string`	No		data type=`string`; maxLen=255

accessibility {
  landmarkType: banner
  regionTitleHtmlId: value
}

javaScript

Property	Type	Required	Default Value	Details
`fileUrls`	`array of strings`	No		data type=`string`; maxLen=4000
`executeWhenPageLoads`	`multiline string`	No		data type=`multiline string`; maxLen=4000

javaScript {
  fileUrls: [
    value
    value
  ]
  executeWhenPageLoads: ```javascript-browser
    value
  ```
}

css

Property	Type	Required	Default Value	Details
`fileUrls`	`array of strings`	No		data type=`string`; maxLen=4000

css {
  fileUrls: [
    value
    value
  ]
}

advanced

Property	Type	Required	Default Value	Details
`staticId`	`string`	Yes		data type=`string`; maxLen=255
`identifier`	`string`	No		data type=`string`; maxLen=255
`translatable`	`boolean`	Yes	`false`	data type=`boolean`

advanced {
  staticId: value
  identifier: value
  translatable: false
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`regionTemplate`
`master`	`enum`	No		data type=`reference`; lov=`COMPONENT`; references=`regionTemplate` Valid values: `@/8842.242/universal-theme/alert` `@/8842.242/universal-theme/blank-with-attributes` `@/8842.242/universal-theme/blank-with-attributes-no-grid` `@/8842.242/universal-theme/buttons-container` `@/8842.242/universal-theme/cards-container` `@/8842.242/universal-theme/carousel-container` `@/8842.242/universal-theme/collapsible` `@/8842.242/universal-theme/content-block` `@/8842.242/universal-theme/hero` `@/8842.242/universal-theme/image` `@/8842.242/universal-theme/inline-dialog` `@/8842.242/universal-theme/inline-drawer` `@/8842.242/universal-theme/inline-popup` `@/8842.242/universal-theme/interactive-report` `@/8842.242/universal-theme/item-container` `@/8842.242/universal-theme/login` `@/8842.242/universal-theme/search-results-container` `@/8842.242/universal-theme/standard` `@/8842.242/universal-theme/tabs-container` `@/8842.242/universal-theme/title-bar` `@/8842.242/universal-theme/wizard-container` `@/8842.261/universal-theme/alert` `@/8842.261/universal-theme/blank-with-attributes` `@/8842.261/universal-theme/blank-with-attributes-no-grid` `@/8842.261/universal-theme/buttons-container` `@/8842.261/universal-theme/cards-container` `@/8842.261/universal-theme/carousel-container` `@/8842.261/universal-theme/collapsible` `@/8842.261/universal-theme/content-block` `@/8842.261/universal-theme/hero` `@/8842.261/universal-theme/image` `@/8842.261/universal-theme/inline-dialog` `@/8842.261/universal-theme/inline-drawer` `@/8842.261/universal-theme/inline-popup` `@/8842.261/universal-theme/interactive-report` `@/8842.261/universal-theme/item-container` `@/8842.261/universal-theme/login` `@/8842.261/universal-theme/search-results-container` `@/8842.261/universal-theme/standard` `@/8842.261/universal-theme/tabs-container` `@/8842.261/universal-theme/title-bar` `@/8842.261/universal-theme/wizard-container` `@/8842.262/universal-theme/alert` `@/8842.262/universal-theme/blank-with-attributes` `@/8842.262/universal-theme/blank-with-attributes-no-grid` `@/8842.262/universal-theme/buttons-container` `@/8842.262/universal-theme/cards-container` `@/8842.262/universal-theme/carousel-container` `@/8842.262/universal-theme/collapsible` `@/8842.262/universal-theme/content-block` `@/8842.262/universal-theme/hero` `@/8842.262/universal-theme/image` `@/8842.262/universal-theme/inline-dialog` `@/8842.262/universal-theme/inline-drawer` `@/8842.262/universal-theme/inline-popup` `@/8842.262/universal-theme/interactive-report` `@/8842.262/universal-theme/item-container` `@/8842.262/universal-theme/login` `@/8842.262/universal-theme/search-results-container` `@/8842.262/universal-theme/standard` `@/8842.262/universal-theme/tabs-container` `@/8842.262/universal-theme/title-bar` `@/8842.262/universal-theme/wizard-container` `@/8842.9999/theme-1000/blank-with-attributes-no-grid`

subscription {
  master: @component
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

regionTemplate sample (
    name: value
    templateClass: borderlessRegion
    templateOptions {
        preset: [
          value
          value
        ]
        default: [
          value
          value
        ]
    }
    region {
        template: ```html
          value
        ```
        image: ```html
          value
        ```
        htmlTableAttributes: value
    }
    subRegions {
        template: ```html
          value
        ```
        header: ```html
          value
        ```
        headerEntry: ```html
          value
        ```
    }
    accessibility {
        landmarkType: banner
        regionTitleHtmlId: value
    }
    javaScript {
        fileUrls: [
          value
          value
        ]
        executeWhenPageLoads: ```javascript-browser
          value
        ```
    }
    css {
        fileUrls: [
          value
          value
        ]
    }
    advanced {
        staticId: value
        identifier: value
        translatable: false
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)