WP Kernel API v0.3.0

---

WP Kernel API / @wpkernel/ui / ResourceDataViewController

Interface: ResourceDataViewController<TItem, TQuery>

Type Parameters

TItem

TItem

TQuery

TQuery

Properties

resource?

readonly optional resource: ResourceObject<TItem, TQuery>;

---

resourceName

readonly resourceName: string;

---

config

readonly config: ResourceDataViewConfig<TItem, TQuery>;

---

queryMapping

readonly queryMapping: QueryMapping<TQuery>;

---

runtime

readonly runtime: DataViewsControllerRuntime;

---

namespace

readonly namespace: string;

---

preferencesKey

readonly preferencesKey: string;

---

invalidate()?

readonly optional invalidate: (patterns) => void;

Parameters

patterns

CacheKeyPattern | CacheKeyPattern[]

Returns

void

---

policies?

readonly optional policies: KernelUIPolicyRuntime;

---

fetchList()?

readonly optional fetchList: (query) => Promise<ListResponse<TItem>>;

Parameters

query

TQuery

Returns

Promise<ListResponse<TItem>>

---

prefetchList()?

readonly optional prefetchList: (query) => Promise<void>;

Parameters

query

TQuery

Returns

Promise<void>

---

mapViewToQuery()

mapViewToQuery: (view) => TQuery;

Parameters

view

View

Returns

TQuery

---

deriveViewState()

deriveViewState: (view) => object;

Parameters

view

View

Returns

object

fields

fields: string[];

sort?

optional sort: object;

sort.field

field: string;

sort.direction

direction: "asc" | "desc";

search?

optional search: string;

filters?

optional filters: Record<string, unknown>;

page

page: number;

perPage

perPage: number;

---

loadStoredView()

loadStoredView: () => Promise<View | undefined>;

Returns

Promise<View | undefined>

---

saveView()

saveView: (view) => Promise<void>;

Parameters

view

View

Returns

Promise<void>

---

emitViewChange()

emitViewChange: (view) => void;

Parameters

view

View

Returns

void

---

emitRegistered()

emitRegistered: (preferencesKey) => void;

Parameters

preferencesKey

string

Returns

void

---

emitUnregistered()

emitUnregistered: (preferencesKey) => void;

Parameters

preferencesKey

string

Returns

void

---

emitAction()

emitAction: (payload) => void;

Parameters

payload

actionId

string

selection

(string | number)[]

permitted

boolean

reason?

string

meta?

Record<string, unknown>

Returns

void

---

getReporter()

getReporter: () => Reporter;

Returns

Reporter