Skip to main content

TemplatedList

Stentor API Reference

Stentor API Reference / stentor-models/src / TemplatedList

Interface: TemplatedList

Defined in: packages/stentor-models/src/Display/List/List.ts:9

Beta

Add to a display that has a list of items to give it the ability to be compiled with variables.

This is a new feature and may not work 100% as expected or may change.

Extended by​

Properties​

itemsObject?​

optional itemsObject: string

Defined in: packages/stentor-models/src/Display/List/List.ts:18

Beta

Used when templating the list for automatic generation.

When using itemsObject, the first item in the list is the template and all other items in the list will be ignored.

This is not yet fully supported

itemsName?​

optional itemsName: string

Defined in: packages/stentor-models/src/Display/List/List.ts:24

Beta

Used with itemsObject, it is then used to reference the current item in the list within the template.

This is not yet fully supported

range?​

optional range: object

Defined in: packages/stentor-models/src/Display/List/List.ts:31

Beta

When itemsObject is provided, this is the amount of list items to display along with the offset within the list.

This is not yet fully supported

length​

length: number

from​

from: number

items?​

optional items: any[]

Defined in: packages/stentor-models/src/Display/List/List.ts:36

Beta