addressWords

const addressWords: object

Defined in: packages/schema/src/app-address.ts:8

The words of the app’s addresses. Only appPath and readAppPath write and read them, so the shape of an address changes in this module alone.

Type Declaration

calendar

readonly calendar: "calendar" = 'calendar'

The month or week a list’s calendar display shows: month,YYYY-MM-DD or week,YYYY-MM-DD.

create

readonly create: "new" = 'new'

The second path segment that opens a resource’s create form instead of a record.

display

readonly display: "display" = 'display'

The list display shown, when it is not the view’s default.

edit

readonly edit: "edit" = 'edit'

A record’s form, edit=true, on a view whose record page opens as a read view or locked.

filter

readonly filter: "filter" = 'filter'

A list’s filter (AIP-160), as the list API takes it. An empty filter= means no filter, in place of the view’s default.

filterLayout

readonly filterLayout: "layout" = 'layout'

Where a list’s filters sit: bar (the default) or panel.

list

readonly list: "list" = 'list'

A named list of the resource (.namedList(...)), in place of its own list.

map

readonly map: "map" = 'map'

Where a list’s map display looks: latitude,longitude,zoom.

open

readonly open: "open" = 'open'

A record page’s open collapsed group, by title, once per group.

orderBy

readonly orderBy: "order_by" = 'order_by'

A list’s order (AIP-132).

savedSearch

readonly savedSearch: "saved_search" = 'saved_search'

The saved search a list was opened from, by its key.