WidgetExportData

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Data attributes for export mode to be added to the widget and its components.

When customizing a widget component, spread these properties in the element intended for export.

export type WidgetExportData = HeaderExportData & {
    section?: CommonExportDataAttributes;
    widget?: WidgetExportDataAttributes;
};

References: HeaderExportData, CommonExportDataAttributes, WidgetExportDataAttributes

Example

const DashboardWidgetComponent: CustomDashboardWidgetComponent = ({ widget, exportData }) => {
  return (
      <div {...exportData?.widget}>
          <div>My custom dashboard widget - {widget?.identifier}</div>
          <div {...exportData?.title}>Widget title</div>
          <div {...exportData?.description}>Widget description</div>
      </div>
  );
};

WidgetExportData

Example

Related