Skip to main content

IDynamicDateRangeOption

Represents a dynamic date range option used by the ui5-dynamic-date-range component.

Represents a dynamic date range option used for handling dynamic date ranges. This interface defines the structure and behavior required for implementing dynamic date range options, including formatting, parsing, validation, and conversion of date range values.

  • Properties:
  • icon: The icon associated with the dynamic date range option, typically used for UI representation.
  • operator: A unique operator identifying the dynamic date range option.
  • text: The display text for the dynamic date range option.
  • template (optional): A JSX template for rendering the dynamic date range option.

Methods:

  • format(value: DynamicDateRangeValue): string: Formats the given dynamic date range value into a string representation.
  • parse(value: string): DynamicDateRangeValue | undefined: Parses a string into a dynamic date range value.
  • toDates(value: DynamicDateRangeValue): Date[]: Converts a dynamic date range value into an array of Date objects.
  • handleSelectionChange?(event: CustomEvent): DynamicDateRangeValue | undefined: (Optional) Handles selection changes in the UI of the dynamic date range option.
  • isValidString(value: string): boolean: Validates whether a given string is a valid representation of the dynamic date range value.

Implementations​

Interfaces doesn't have direct implementations.