Static Functions

Root static functions of RecurrenceEditor Component

NameParametersReturnsDescription
extractObjectFromRule

  • rules

    : string
    • RecRule

    Method to generate recurrence rule object from given rule


    Params:
  • rules: Accepts the recurrence rule
    • getDateFromRecurrenceDateString

  • recDateString

    : string
    • Date

    Generate date object from given date string


    Params:
  • recDateString: Accepts the exception date as string
    • getRecurrenceDates

  • startDate

    : Date

  • rule

    : string

  • excludeDate

    : string

  • startDayOfWeek

    : number

  • maximumCount?

    : number

  • viewDate?

    : Date

  • calendarMode?

    : string
    • number[]

    Generates the date collections from the given recurrence rule


    Params:
  • startDate: Accepts the rule start date
  • rule: Accepts the recurrence rule
  • excludeDate: Accepts the exception dates in string format
  • startDayOfWeek: Accepts the start day index of week
  • maximumCount: Accepts the maximum number count to generate date collections
  • viewDate: Accepts the current date instead of start date
  • calendarMode: Accepts the calendar type
    • getRecurrenceSummary

  • rule

    : string

  • locale

    : string

  • localeObject?

    : IL10n
    • string

    Generate Summary from Recurrence Rule


    Params:
  • rule: Accepts the Recurrence rule
  • locale: Accepts the locale name
  • localeObject: Accepts the locale object (optional)
    • useRecurrenceEditor

  • value

    : string

  • startDate

    : Date

  • frequencies

    : FreqType[]

  • endTypes

    : EndType[]

  • firstDayOfWeek

    : number
    • RecurrenceEditorResult

    Hook that prepares state, localized data sources and helper functions


    Params:
  • value: Initial recurrence rule string (RRULE). May be empty.
  • startDate: The event start date used when computing rule parts.
  • frequencies: Allowed frequency values (e.g. ['DAILY','WEEKLY']).
  • endTypes: Allowed end types (e.g. ['Count','Until']).
  • firstDayOfWeek: Locale-specific index of first day (0 = Sunday).
    • getByDayFromDate

  • date

    : Date
    • string

    Gets the two-letter weekday code for a given date.


    Params:
  • date: The input Date object to extract the weekday from.
    • getBySetPosFromDate

  • date

    : Date
    • number

    Calculates the set position (week index) of the provided date within its month


    Params:
  • date: The date to evaluate.
    • getDefaultRule

  • freq

    : FreqType

  • date

    : Date
    • string

    Generates a default iCalendar recurrence rule (RFC 5545) string for a given frequency and reference date.


    Params:
  • freq: Recurrence frequency.
  • date: Reference Date used to derive day/month parts. If falsy or invalid, the current date is used.
    • getRecurrenceStateFromRule

  • rule

    : string

  • state

    : RecurrenceState
    • RecurrenceState

    Get the recurrence states from rule


    Params:
  • rule: Recurrence rule string
  • state: Initial recurrence states
    • getRecurrenceStringFromDate

  • date

    : Date
    • string

    Method to generate string from date


    Params:
  • date: Accepts the date value