Interface DynamicDataListProps<T>

Type Parameters

Hierarchy

  • DynamicDataListProps

Properties

allowAddAndRemove? allowEditing? allowNewData? allowReordering? allowRowDragging? className? columnGap? columns customDataEntry? defaultValuesForNewData? disabled? headerRowHeight? horizontalTextAlign? inlineMenuActions? listRowActionSize? listRowHeight? maxItemLimit? minimumWidth? onAddTransformData? onChange? positionLabel? positionPropertyName? rowClassNameProvider? rowGap? rowValidationSchema? showHeader? stickyHeader? value verticalTextAlign?

Properties

Optional allowAddAndRemove

allowAddAndRemove?: boolean

Deprecated

Determines if the Add and Delete action buttons are rendered (default: true)

Optional allowEditing

allowEditing?: boolean

Whether or not existing data can be edited (default: false)

Optional allowNewData

allowNewData?: boolean

Whether or not new data can be added (default: false)

Optional allowReordering

allowReordering?: boolean

Whether or not rows can be repositioned (default: true)

Optional allowRowDragging

allowRowDragging?: boolean

Determines if data rows can be dragged for repositioning (default: true)

Optional className

className?: string

CSS Class name for additional styles

Optional columnGap

columnGap?: string

Spacing between columns

columns

columns: DynamicListColumn<T>[]

Column definitions The order of this array determines the order of columns

Optional customDataEntry

customDataEntry?: FC<DynamicListDataEntryProps<T>>

Custom DynamicListDataEntry component which will be rendered instead of the default component

Optional defaultValuesForNewData

defaultValuesForNewData?: Partial<T>

Sets default values to be populated in the new row when new data is allowed.

Optional disabled

disabled?: boolean

Whether add new item button should be disabled (default: false)

Optional headerRowHeight

headerRowHeight?: string

Header row height

Optional horizontalTextAlign

horizontalTextAlign?: "center" | "left" | "right"

Horizontal alignment of text

Optional inlineMenuActions

inlineMenuActions?: ((data) => ActionData[])

Type declaration

    • (data): ActionData[]

    • Provide inline actions which are available through '...' context menu

      Parameters

      • data: T

      Returns ActionData[]

Optional listRowActionSize

listRowActionSize?: string

List row action button and checkbox size (default: '50px')

Optional listRowHeight

listRowHeight?: string

List row height (minimum height is 50px)

Optional maxItemLimit

maxItemLimit?: number

The maximum amount of items that can be added to the list. If this prop is set and the amount is reached, data entry will be removed (default: undefined)

Optional minimumWidth

minimumWidth?: string

Minimum width of this component

Optional onAddTransformData

onAddTransformData?: ((data) => T)

Type declaration

    • (data): T

    • Performs transformations to the new data object being added

      Parameters

      • data: Partial<T>

      Returns T

Optional onChange

onChange?: ((list) => void)

Type declaration

    • (list): void

    • Raised when the list has changed

      Parameters

      • list: T[]

      Returns void

Optional positionLabel

positionLabel?: string

If sets, sets the label for the position column (default: 'Position')

Optional positionPropertyName

positionPropertyName?: keyof T

Property that contains the value used in reordering the list (default: undefined)

Optional rowClassNameProvider

rowClassNameProvider?: ((data) => string)

Type declaration

    • (data): string

    • CSS Class name provider for each row. Allows row style to be determined by data

      Parameters

      • data: T

      Returns string

Optional rowGap

rowGap?: string

Spacing between rows

Optional rowValidationSchema

rowValidationSchema?: OptionalObjectSchema<ObjectSchemaDefinition<T>, AnyObject, TypeOfShape<ObjectSchemaDefinition<T>>>

Optional Yup validation object for validating new data

Optional showHeader

showHeader?: boolean

Whether or not the header row is shown (default: true)

Optional stickyHeader

stickyHeader?: boolean

Whether the header and input field should stick to the top (default: false)

value

value: T[]

List data

Optional verticalTextAlign

verticalTextAlign?: "center" | "end" | "start"

Vertical alignment of text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc