DataViewsField
Defined in: wp-typia-dataviews/src/types.ts:168
Field definition surface owned by wp-typia.
Remarks
Section titled “Remarks”Rendering hooks return unknown instead of React nodes so this package does
not force React or Gutenberg declarations onto default scaffold consumers.
Type Parameters
Section titled “Type Parameters”TItem extends object = DataViewsRecord
TValue
Section titled “TValue”TValue = unknown
Properties
Section titled “Properties”description?
Section titled “description?”
readonlyoptionaldescription?:string
Defined in: wp-typia-dataviews/src/types.ts:172
elements?
Section titled “elements?”
readonlyoptionalelements?: readonlyDataViewsFieldElement<DataViewsFieldElementValue<TValue>>[]
Defined in: wp-typia-dataviews/src/types.ts:173
enableGlobalSearch?
Section titled “enableGlobalSearch?”
readonlyoptionalenableGlobalSearch?:boolean
Defined in: wp-typia-dataviews/src/types.ts:176
enableHiding?
Section titled “enableHiding?”
readonlyoptionalenableHiding?:boolean
Defined in: wp-typia-dataviews/src/types.ts:177
enableSorting?
Section titled “enableSorting?”
readonlyoptionalenableSorting?:boolean
Defined in: wp-typia-dataviews/src/types.ts:178
filterBy?
Section titled “filterBy?”
readonlyoptionalfilterBy?:DataViewsFieldFilter
Defined in: wp-typia-dataviews/src/types.ts:179
format?
Section titled “format?”
readonlyoptionalformat?:DataViewsFieldFormat
Defined in: wp-typia-dataviews/src/types.ts:180
getValue?
Section titled “getValue?”
readonlyoptionalgetValue?: (context) =>TValue
Defined in: wp-typia-dataviews/src/types.ts:181
Parameters
Section titled “Parameters”context
Section titled “context”DataViewsFieldContext<TItem, TValue>
Returns
Section titled “Returns”TValue
getValueFormatted?
Section titled “getValueFormatted?”
readonlyoptionalgetValueFormatted?: (context) =>string
Defined in: wp-typia-dataviews/src/types.ts:182
Parameters
Section titled “Parameters”context
Section titled “context”DataViewsFieldContext<TItem, TValue>
Returns
Section titled “Returns”string
header?
Section titled “header?”
readonlyoptionalheader?:string
Defined in: wp-typia-dataviews/src/types.ts:183
readonlyid:Extract<keyofTItem>
Defined in: wp-typia-dataviews/src/types.ts:184
isValid?
Section titled “isValid?”
readonlyoptionalisValid?:DataViewsFieldValidationRules<TItem,TValue>
Defined in: wp-typia-dataviews/src/types.ts:185
readonlylabel:string
Defined in: wp-typia-dataviews/src/types.ts:186
placeholder?
Section titled “placeholder?”
readonlyoptionalplaceholder?:string
Defined in: wp-typia-dataviews/src/types.ts:187
readOnly?
Section titled “readOnly?”
readonlyoptionalreadOnly?:boolean
Defined in: wp-typia-dataviews/src/types.ts:188
render?
Section titled “render?”
readonlyoptionalrender?: (context) =>unknown
Defined in: wp-typia-dataviews/src/types.ts:189
Parameters
Section titled “Parameters”context
Section titled “context”DataViewsFieldContext<TItem, TValue>
Returns
Section titled “Returns”unknown
setValue?
Section titled “setValue?”
readonlyoptionalsetValue?: (context) =>TItem
Defined in: wp-typia-dataviews/src/types.ts:190
Parameters
Section titled “Parameters”context
Section titled “context”DataViewsFieldUpdateContext<TItem, TValue>
Returns
Section titled “Returns”TItem
readonlyoptionalsort?: (left,right,direction) =>number
Defined in: wp-typia-dataviews/src/types.ts:191
Parameters
Section titled “Parameters”TItem
TItem
direction
Section titled “direction”"desc" | "asc"
Returns
Section titled “Returns”number
readonlyoptionaltype?:"number"|"boolean"|"object"|"text"|"email"|"url"|"date"|"array"|"integer"|"datetime"|"media"
Defined in: wp-typia-dataviews/src/types.ts:196