Class DocumentListBuilder

Class for building document list

Hierarchy (View Summary)

GenericListBuilder<PartialDocumentList, DocumentListBuilder>
- DocumentListBuilder
  - DocumentTypeListBuilder

Constructors

constructor

new DocumentListBuilder(
_context: StructureContext,
spec?: DocumentListInput,
): DocumentListBuilder
Parameters
- _context: StructureContext
  Structure context. See StructureContext
- Optionalspec: DocumentListInput
Returns DocumentListBuilder
Overrides GenericListBuilder.constructor
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:124

Properties

`Readonly`[serializableMarker]

"[serializableMarker]": true

Brand consumed by isSerializable (avoids circular instanceof imports)

Methods

apiVersion

apiVersion(apiVersion: string): DocumentListBuilder
Set API version
Parameters
- apiVersion: string
  API version
Returns DocumentListBuilder
document list builder based on the options and API version provided. See DocumentListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:141

canHandleIntent

canHandleIntent(canHandleIntent?: IntentChecker): DocumentListBuilder
Set generic list can handle intent
Parameters
- OptionalcanHandleIntent: IntentChecker
  generic list intent checker. See IntentChecker
Returns DocumentListBuilder
generic list builder based on can handle intent provided.
Inherited from GenericListBuilder.canHandleIntent
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:240

child

child(child: Child): DocumentListBuilder
Set generic list child
Parameters
- child: Child
  generic list child. See Child
Returns DocumentListBuilder
generic list builder based on child provided (clone).
Inherited from GenericListBuilder.child
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:225

clone

clone(withSpec?: PartialDocumentList): DocumentListBuilder
Clone Document list builder (allows for options overriding)
Parameters
- OptionalwithSpec: PartialDocumentList
  override document list spec. See PartialDocumentList
Returns DocumentListBuilder
document list builder. See DocumentListBuilder
Overrides GenericListBuilder.clone
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:269

defaultLayout

defaultLayout(defaultLayout: PreviewLayoutKey): DocumentListBuilder
Set generic list layout
Parameters
- defaultLayout: PreviewLayoutKey
  generic list layout key.
Returns DocumentListBuilder
generic list builder based on layout provided.
Inherited from GenericListBuilder.defaultLayout
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:180

defaultOrdering

defaultOrdering(ordering: SortOrderingItem[]): DocumentListBuilder
Set Document list default ordering
Parameters
- ordering: SortOrderingItem[]
  default sort ordering array. See SortOrderingItem
Returns DocumentListBuilder
document list builder based on ordering provided. See DocumentListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:204

filter

filter(filter: string): DocumentListBuilder
Set Document list filter
Parameters
- filter: string
  GROQ-filter used to determine which documents to display. Do not support joins, since they operate on individual documents, and will ignore order-clauses and projections. See https://www.sanity.io/docs/realtime-updates
Returns DocumentListBuilder
document list builder based on the options and filter provided. See DocumentListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:156

getApiVersion

getApiVersion(): string
Get API version

Returns string
API version
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:148

getCanHandleIntent

getCanHandleIntent(): IntentChecker
Get generic list can handle intent

Returns IntentChecker
generic list can handle intent
Inherited from GenericListBuilder.getCanHandleIntent
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:247

getFilter

getFilter(): string
Get Document list filter

Returns string
filter
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:163

getI18n

getI18n(): I18nTextRecord<"title">
Get i18n key and namespace used to populate the localized title

Returns I18nTextRecord<"title">
the i18n key and namespace used to populate the localized title
Inherited from GenericListBuilder.getI18n
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:172

getId

getId(): string
Get generic list ID

Returns string
generic list ID
Inherited from GenericListBuilder.getId
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:142

getInitialValueTemplates

getInitialValueTemplates(): (
InitialValueTemplateItem
| InitialValueTemplateItemBuilder
)[]
Get generic list initial value templates

Returns (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[]
generic list initial value templates
Inherited from GenericListBuilder.getInitialValueTemplates
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:285

getMenuItemGroups

getMenuItemGroups(): (MenuItemGroup | MenuItemGroupBuilder)[]
Get generic list menu item groups

Returns (MenuItemGroup | MenuItemGroupBuilder)[]
generic list menu item groups
Inherited from GenericListBuilder.getMenuItemGroups
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:217

getMenuItems

getMenuItems(): (MenuItem | MenuItemBuilder)[]
Get generic list menu items

Returns (MenuItem | MenuItemBuilder)[]
generic list menu items
Inherited from GenericListBuilder.getMenuItems
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:202

getParams

getParams(): Record<string, unknown>
Get Document list options' parameters

Returns Record<string, unknown>
options
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:196

getSchemaType

getSchemaType(): string
Get Document list schema type name

Returns string
schema type name
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:179

getShowIcons

getShowIcons(): boolean
Get generic list display options

Returns boolean
generic list display options (specifically showIcons)
Inherited from GenericListBuilder.getShowIcons
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:264

getSpec

getSpec(): PartialDocumentList
Get Document list spec

Returns PartialDocumentList
document list spec. See PartialDocumentList
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:287

getTitle

getTitle(): string
Get generic list title

Returns string
generic list title
Inherited from GenericListBuilder.getTitle
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:157

i18n

i18n(i18n: I18nTextRecord<"title">): DocumentListBuilder
Set the i18n key and namespace used to populate the localized title.
Parameters
- i18n: I18nTextRecord<"title">
  the key and namespaced used to populate the localized title.
Returns DocumentListBuilder
component builder based on i18n key and ns provided
Inherited from GenericListBuilder.i18n
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:165

id

id(id: string): DocumentListBuilder
Set generic list ID
Parameters
- id: string
  generic list ID
Returns DocumentListBuilder
generic list builder based on ID provided.
Inherited from GenericListBuilder.id
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:135

initialValueTemplates

initialValueTemplates(
    templates:
        | InitialValueTemplateItem
        | InitialValueTemplateItemBuilder
        | (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[],
): DocumentListBuilder
Set generic list initial value templates
Parameters
- templates:
      | InitialValueTemplateItem
      | InitialValueTemplateItemBuilder
      | (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[]
  generic list initial value templates. See InitialValueTemplateItemBuilder
Returns DocumentListBuilder
generic list builder based on templates provided.
Inherited from GenericListBuilder.initialValueTemplates
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:272

menuItemGroups

menuItemGroups(
menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[],
): DocumentListBuilder
Set generic list menu item groups
Parameters
- menuItemGroups: (MenuItemGroup | MenuItemGroupBuilder)[]
  generic list menu item groups. See MenuItemGroup and MenuItemGroupBuilder
Returns DocumentListBuilder
generic list builder based on menu item groups provided.
Inherited from GenericListBuilder.menuItemGroups
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:210

menuItems

menuItems(menuItems: (MenuItem | MenuItemBuilder)[]): DocumentListBuilder
Set generic list menu items
Parameters
- menuItems: (MenuItem | MenuItemBuilder)[]
  generic list menu items. See MenuItem and MenuItemBuilder
Returns DocumentListBuilder
generic list builder based on menu items provided.
Inherited from GenericListBuilder.menuItems
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:195

params

params(params: Record<string, unknown>): DocumentListBuilder
Set Document list options' parameters
Parameters
- params: Record<string, unknown>
  parameters
Returns DocumentListBuilder
document list builder based on the options provided. See DocumentListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:187

schemaType

schemaType(type: string | SchemaType): DocumentListBuilder
Set Document list schema type name
Parameters
- type: string | SchemaType
  schema type name.
Returns DocumentListBuilder
document list builder based on the schema type name provided. See DocumentListBuilder
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:171

serialize

serialize(options?: SerializeOptions): DocumentList
Serialize Document list
Parameters
- options: SerializeOptions = ...
  serialization options. See SerializeOptions
Returns DocumentList
document list object based on path provided in options. See DocumentList
Overrides GenericListBuilder.serialize
- Defined in packages/sanity/src/structure/structureBuilder/DocumentList.ts:225

showIcons

showIcons(enabled?: boolean): DocumentListBuilder
Set generic list display options
Parameters
- enabled: boolean = true
  allow / disallow for showing icons
Returns DocumentListBuilder
generic list builder based on display options (showIcons) provided.
Inherited from GenericListBuilder.showIcons
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:255

title

title(title: string): DocumentListBuilder
Set generic list title
Parameters
- title: string
  generic list title
Returns DocumentListBuilder
generic list builder based on title and ID provided.
Inherited from GenericListBuilder.title
- Defined in packages/sanity/src/structure/structureBuilder/GenericList.ts:150

Class DocumentListBuilder

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DocumentListBuilder

Properties

Readonly[serializableMarker]

Methods

apiVersion

Parameters

Returns DocumentListBuilder

canHandleIntent

Parameters

Returns DocumentListBuilder

child

Parameters

Returns DocumentListBuilder

clone

Parameters

Returns DocumentListBuilder

defaultLayout

Parameters

Returns DocumentListBuilder

defaultOrdering

Parameters

Returns DocumentListBuilder

filter

Parameters

Returns DocumentListBuilder

getApiVersion

Returns string

getCanHandleIntent

Returns IntentChecker

getChild

Returns Child

getDefaultLayout

Returns PreviewLayoutKey

getDefaultOrdering

Returns SortOrderingItem[]

getFilter

Returns string

getI18n

Returns I18nTextRecord<"title">

getId

Returns string

getInitialValueTemplates

Returns (InitialValueTemplateItem | InitialValueTemplateItemBuilder)[]

getMenuItemGroups

Returns (MenuItemGroup | MenuItemGroupBuilder)[]

getMenuItems

Returns (MenuItem | MenuItemBuilder)[]

getParams

Returns Record<string, unknown>

getSchemaType

Returns string

getShowIcons

Returns boolean

getSpec

Returns PartialDocumentList

getTitle

Returns string

i18n

Parameters

Returns DocumentListBuilder

id

Parameters

Returns DocumentListBuilder

initialValueTemplates

Parameters

Returns DocumentListBuilder

menuItemGroups

Parameters

Returns DocumentListBuilder

menuItems

Parameters

`Readonly`[serializableMarker]