Interface DynamicListDataEntryProps<T>

Type Parameters

Hierarchy

  • DynamicListDataEntryProps

Properties

actionButtonContext? actionSize? allowDragging? allowReordering? className? columnGap? columnSizes columns customAddButton? defaultValuesForNewData? disabled? horizontalTextAlign? mode? newDataPosition? onActionClicked? positionKey? rowHeight? rowValidationSchema? showHeader? showPositionColumn? sticky? verticalTextAlign?

Properties

Optional actionButtonContext

actionButtonContext?: ButtonContext

Overrides the default action button context behavior

Optional actionSize

actionSize?: string

Size of action button and checkbox

Optional allowDragging

allowDragging?: boolean

If set to true, this component can be dragged (default: undefined)

Optional allowReordering

allowReordering?: boolean

If set to true, rows can be be repositioned using the input field (default: undefined)

Optional className

className?: string

CSS Class name for additional styles

Optional columnGap

columnGap?: string

Header row height

columnSizes

columnSizes: string

Spacing between columns

columns

columns: DynamicListColumn<T>[]

The column definition

Optional customAddButton

customAddButton?: ((onAddItem) => ReactElement<any, string | JSXElementConstructor<any>>)

Type declaration

    • (onAddItem): ReactElement<any, string | JSXElementConstructor<any>>

    • override default add button (+)

      Parameters

      • onAddItem: (() => Promise<void>)
          • (): Promise<void>

          • Returns Promise<void>

      Returns ReactElement<any, string | JSXElementConstructor<any>>

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

Optional horizontalTextAlign

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

Horizontal alignment of text

Optional mode

mode?: DynamicListDataEntryMode

Determines if the component is in Add or Edit mode (default: Add)

Optional newDataPosition

newDataPosition?: number

Position the new data will receive

Optional onActionClicked

onActionClicked?: ((data) => void)

Type declaration

    • (data): void

    • Emits when the action button is clicked. Data is supplied as a parameter

      Parameters

      • data: T

      Returns void

Optional positionKey

positionKey?: keyof T

Property name that is used to determine data position (default: undefined)

Optional rowHeight

rowHeight?: string

List row height

Optional rowValidationSchema

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

Optional Yup validation object for validating new data

Optional showHeader

showHeader?: boolean

If header is shown

Optional showPositionColumn

showPositionColumn?: boolean

If set to true, the position column will be shown (default: false)

Optional sticky

sticky?: boolean

Whether Data Entry row should stick to the top below Header (default: true)

Optional verticalTextAlign

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

Vertical alignment of text

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc