Lowdefy
v3.17.2/input/MonthSelector/

MonthSelector

value type: date

The MonthSelector block allows a user to select a month. The value is a date object, with day and time values of midnight on the first day of the month GMT.

Other date type blocks are DateRangeSelector, DateSelector, DateTimeSelector and WeekSelector.

block_id: null


id: block_id
type: MonthSelector
properties:
  disabledDates:
    dates: []
    ranges: []
properties:
Allow the user to clear their input.
Autofocus to the block on page load.
Disable the block if true.
disabledDates:
dates:
No Items

Disable all dates greater than the maximum date. Can be a date string or a _date object.
Disable all dates less than the minimum date. Can be a date string or a _date object.
ranges:
No Items

Format in which to format the date value, eg. "MMMM YYYY" will format a date value of 1999-12-31 as "December 1999". The format has to conform to moment.js formats.
Css style to applied to input.
label:
Align label left or right when inline.
Append label with colon.
Hide input label.
Extra text to display beneath the content.
Css style to applied to label extra.
Css style to applied to label feedback.
Display feedback extra from validation, this does not disable validation.
Render input and label inline.
Label inline span.
Label title.
Placeholder text inside the block before user types input.
Shows a button to easily select the current date if true.
Size of the block.
CalendarOutlined
Name of an Ant Design Icon or properties of an Icon block to customize icon on right-hand side of the date picker.
Month selector label title.
type: object
properties:
  events:
    additionalProperties: false
    properties:
      onChange:
        description: Trigger actions when selection is changed.
        type: array
    type: object
  properties:
    additionalProperties: false
    properties:
      allowClear:
        default: true
        description: Allow the user to clear their input.
        type: boolean
      autoFocus:
        default: false
        description: Autofocus to the block on page load.
        type: boolean
      disabled:
        default: false
        description: Disable the block if true.
        type: boolean
      disabledDates:
        description: Disable specific dates so that they can not be chosen.
        properties:
          dates:
            description: >-
              Array of specific dates to be disabled. Can be date strings or a
              _date objects.
            items:
              description: Specific dates to be disabled.
              type:
                - string
                - object
            type: array
          max:
            description: >-
              Disable all dates greater than the maximum date. Can be a date
              string or a _date object.
            type:
              - string
              - object
          min:
            description: >-
              Disable all dates less than the minimum date. Can be a date string
              or a _date object.
            type:
              - string
              - object
          ranges:
            description: >-
              Array of array pairs of start and end dates be disabled. Can be date
              strings or a _date objects.
            items:
              description: Specific date ranges to be disabled.
              items:
                type:
                  - string
                  - object
              type: array
            type: array
        type: object
      format:
        default: YYYY-MM
        description: >-
          Format in which to format the date value, eg. "MMMM YYYY" will format a
          date value of 1999-12-31 as "December 1999". The format has to conform
          to moment.js formats.
        type: string
      inputStyle:
        description: Css style to applied to input.
        type: object
      label:
        additionalProperties: false
        description: Label properties.
        properties:
          align:
            default: left
            description: Align label left or right when inline.
            enum:
              - left
              - right
            type: string
          colon:
            default: true
            description: Append label with colon.
            type: boolean
          disabled:
            default: false
            description: Hide input label.
            type: boolean
          extra:
            description: Extra text to display beneath the content.
            type: string
          extraStyle:
            description: Css style to applied to label extra.
            type: object
          feedbackStyle:
            description: Css style to applied to label feedback.
            type: object
          hasFeedback:
            default: true
            description: >-
              Display feedback extra from validation, this does not disable
              validation.
            type: boolean
          inline:
            default: false
            description: Render input and label inline.
            type: boolean
          span:
            description: Label inline span.
            type: number
          title:
            description: Label title.
            type: string
        type: object
      placeholder:
        default: Select Month
        description: Placeholder text inside the block before user types input.
        type: string
      showToday:
        default: true
        description: Shows a button to easily select the current date if true.
        type: boolean
      size:
        default: default
        description: Size of the block.
        enum:
          - small
          - default
          - large
        type: string
      suffixIcon:
        default: CalendarOutlined
        description: >-
          Name of an Ant Design Icon or properties of an Icon block to customize
          icon on right-hand side of the date picker.
        type:
          - string
          - object
      title:
        description: Month selector label title.
        type: string
    type: object