DatePicker
==========

.. granite:servercomponent:: /libs/granite/ui/components/foundation/form/datepicker
   :supertype: /libs/granite/ui/components/foundation/form/field
   :deprecated:

   DatePicker is an input component where the user can enter date.

   It extends :granite:servercomponent:`Field </libs/granite/ui/components/foundation/form/field>` component.

   It has the following content structure:

   .. gnd:gnd::

      [granite:FormDatePicker] > granite:FormField

      /**
       * The id attribute.
       */
      - id (String)

      /**
       * The class attribute. This is used to indicate the semantic relationship of the component similar to ``rel`` attribute.
       */
      - rel (String)

      /**
       * The class attribute.
       */
      - class (String)

      /**
       * The title attribute.
       */
      - title (String) i18n

      /**
       * The name that identifies the field when submitting the form.
       * The `SlingPostServlet @TypeHint <http://sling.apache.org/documentation/bundles/manipulating-content-the-slingpostservlet-servlets-post.html#typehint>`_ hidden input with value ``Date`` is also generated based on the name.
       */
      - name (String)

      /**
       * The value of the field.
       */
      - value (StringEL)

      /**
       * A hint to the user of what can be entered in the field.
       */
      - emptyText (String) i18n

      /**
       * Indicates if the field is in disabled state.
       */
      - disabled (Boolean)

      /**
       * Indicates if the field is mandatory to be filled.
       */
      - required (Boolean)

      /**
       * The name of the validator to be applied. E.g. ``foundation.jcr.name``.
       * See :doc:`validation </jcr_root/libs/granite/ui/components/foundation/clientlibs/foundation/js/validation/index>` in Granite UI.
       */
      - validation (String) multiple

      /**
       * The type of the picker.
       */
      - type (String) = 'date' < 'date', 'datetime', 'time'

      /**
       * The date format to be displayed.
       */
      - displayedFormat (String) i18n

      /**
       * The date format for form submission.
       */
      - storedFormat = 'YYYY-MM-DD[T]HH:mm:ss.SSSZ'

      /**
       * The minimum boundary of the date.
       */
      - minDate (String)

      /**
       * The maximum boundary of the date.
       */
      - maxDate (String)

      /**
       * Indicates if a informative message should be displayed regarding timezone prevalence
       */
      - displayTimezoneMessage (Boolean)