@dnb/eufemia
Version:
DNB Eufemia Design System UI Library
79 lines (78 loc) • 2.47 kB
TypeScript
import React from 'react';
import { OnCommit, Path } from '../../types';
import { SpacingProps } from '../../../../shared/types';
import { ArrayItemAreaProps } from '../Array/ArrayItemArea';
type OnlyPathRequired = {
/**
* The path to the array to add the new item to.
*/
path: Path;
/** The sub path to the array to add the new item to. */
itemPath?: Path;
};
type OnlyItemPathRequired = {
/**
* The path to the array to add the new item to.
*/
path?: Path;
/** The sub path to the array to add the new item to. */
itemPath: Path;
};
export type Props = (OnlyPathRequired | OnlyItemPathRequired) & {
/**
* The title of the container.
*/
title?: React.ReactNode;
/**
* If the fields inside the container are required.
*/
required?: boolean;
/**
* The index to insert the new item at.
*/
insertAt?: number;
/**
* The button to open container.
*/
openButton?: React.ReactNode;
/**
* Define when the "open button" should be shown.
* Should be a function that returns a boolean.
*/
showOpenButtonWhen?: (list: unknown[]) => boolean;
/**
* Prefilled data to add to the fields. The data will be put into this path: "/pushContainerItems/0".
*/
data?: unknown | Record<string, unknown>;
/**
* Prefilled data to add to the fields. The data will be put into this path: "/pushContainerItems/0".
*/
defaultData?: unknown | Record<string, unknown>;
/**
* Provide additional data that will be put into the root of the isolated data context (parallel to "/pushContainerItems/0").
*/
isolatedData?: Record<string, unknown>;
/**
* Prevent the form from being submitted when there are fields with errors inside the PushContainer.
*/
bubbleValidation?: boolean;
/**
* A custom toolbar to be shown below the container.
*/
toolbar?: React.ReactNode;
/**
* Will be called when the user clicks on the "Done" button.
*/
onCommit?: OnCommit;
/**
* The container contents.
*/
children: React.ReactNode;
};
export type AllProps = Props & SpacingProps & ArrayItemAreaProps;
declare function PushContainer(props: AllProps): import("react/jsx-runtime").JSX.Element;
declare namespace PushContainer {
var OpenButton: typeof import("./OpenButton").default;
var _supportsSpacingProps: boolean;
}
export default PushContainer;