breadcrumbTemplate - APEXlang Reference

`breadcrumbTemplate`

Parent: theme

Children: 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: `breadcrumb` `hierarchical` `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
  ]
}

breadcrumb

Property	Type	Required	Default Value	Details
`startWith`	`enum`	Yes	`parentToLeaf`	data type=`string`; lov=`STATIC` Valid values: `childBreadcrumbEntries` `currentBreadcrumb` `parentBreadcrumbEntries` `parentToLeaf`
`beforeEntries`	`multiline string`	No		data type=`multiline string`; maxLen=4000
`betweenEntries`	`multiline string`	No		data type=`multiline string`; maxLen=4000
`maxEntries`	`integer`	Yes	`12`	data type=`integer`; maxLen=32767
`afterEntries`	`multiline string`	No		data type=`multiline string`; maxLen=4000

breadcrumb {
  startWith: childBreadcrumbEntries
  beforeEntries: ```html
    value
  ```
  betweenEntries: ```html
    value
  ```
  maxEntries: 42
  afterEntries: ```html
    value
  ```
}

entry

Property	Type	Required	Details
`currentPage`	`multiline string`	No	data type=`multiline string`; maxLen=4000
`nonCurrentPage`	`multiline string`	No	data type=`multiline string`; maxLen=4000
`linkAttributes`	`string`	No	data type=`string`; maxLen=4000

entry {
  currentPage: ```html
    value
  ```
  nonCurrentPage: ```html
    value
  ```
  linkAttributes: 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=`breadcrumbTemplate`
`master`	`enum`	No		data type=`reference`; lov=`COMPONENT`; references=`breadcrumbTemplate` Valid values: `@/8842.242/universal-theme/breadcrumb` `@/8842.261/universal-theme/breadcrumb` `@/8842.262/universal-theme/breadcrumb` `@/8842.9999/theme-1000/Breadcrumb`

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

breadcrumbTemplate sample (
    name: value
    templateClass: breadcrumb
    templateOptions {
        preset: [
          value
          value
        ]
        default: [
          value
          value
        ]
    }
    breadcrumb {
        startWith: childBreadcrumbEntries
        beforeEntries: ```html
          value
        ```
        betweenEntries: ```html
          value
        ```
        maxEntries: 42
        afterEntries: ```html
          value
        ```
    }
    entry {
        currentPage: ```html
          value
        ```
        nonCurrentPage: ```html
          value
        ```
        linkAttributes: value
    }
    advanced {
        staticId: value
        identifier: value
        translatable: false
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)