DataForm

import { DataForm } from '@wordpress/dataviews';

View on Storybook

View source on GitHub

PropsPermalink to this section

NameDefaultDescription
data Required

Item

fields Required

Field< Item >[]

form Required

{ layout?: Layout; fields?: Array< FormField | string >; }

onChange Required

( value: Record< string, any > ) => void

validity

Record< string, FieldValidity > | undefined

ExamplesPermalink to this section

Layout CardPermalink to this section

const LayoutCard = () => <DataForm withHeader withSummary isCollapsible />;

Layout DetailsPermalink to this section

const LayoutDetails = () => <DataForm />;

Layout PanelPermalink to this section

const LayoutPanel = () => <DataForm openAs="default" />;

Layout RegularPermalink to this section

const LayoutRegular = () => <DataForm disabled={false} />;

Layout RowPermalink to this section

const LayoutRow = () => <DataForm alignment="default" />;

Layout MixedPermalink to this section

const LayoutMixed = () => <DataForm />;

ValidationPermalink to this section

const Validation = () => <DataForm
    layout="regular"
    required
    elements="sync"
    custom="sync"
    pattern={false}
    minMax={false} />;

VisibilityPermalink to this section

const Visibility = () => <DataForm />;

Data AdapterPermalink to this section

const DataAdapter = () => <DataForm />;