ember-cli-date-textbox

    3.16.0 • Public • Published

    ember-cli-date-textbox

    npm version downloads Code Climate

    ember-observer-badge

    A textbox that will guess the date you want and assign it to your model or query-params.

    Compatibility

    • Ember.js v3.12 or above
    • Ember CLI v2.13 or above
    • Node.js v10 or above
    • Requires ember-auto-import >= 2 & the latest webpack

    Installation

    The following will install this add-on:

    ember install ember-cli-date-textbox
    
    yarn add -D ember-auto-import webpack

    Dependencies

    The following dependencies are used with this addon and may collide with dependencies in your app/addon:

    • ember-cli-text-support-mixins
    • moment
    • moment-timezone
    • sugar

    Demo

    The demonstration web application can be found here: http://ember-cli-date-textbox.cybertooth.io/.

    Usage

    As mentioned above there are several examples on the demonstration site: http://ember-cli-date-textbox.cybertooth.io/

    What Does This Add-on Do?

    This add-on supplies the following components:

    • input-date - a basic HTML textbox that will take your input and try to parse it to a date. If the parse succeeds, the date will be formatted according to your preference. Ideal for binding to your model's date fields (e.g. DS.attr('date')) or to your component or controller's properties.
    • input-iso8601 - another basic HTML textbox that will once again take your input, parse it to a date, and then store the ISO8601 representation of the date. This is a great way for binding your date to Ember's query parameters.

    Further information about these items can be found in the Usage section below and in the demo (dummy) application.

    Some Bootstrap Love...

    If the supplied value can't be parsed to a date, we add the has-error style class to the .form-group that the {{input-date}} and/or {{input-iso8601}} belongs to. This visualizes that the date parse was rejected.

    Components

    {{input-date}}

    This component makes a textbox. It takes in user input in the form of a date that is swiftly parsed and formatted. The parsed date object is assigned to the component's date property.

    Arguments
    • date - REQUIRED. Rather than binding to the value property, this textbox input will be binding to the date attribute.
    • value - DO NOT USE. I mention the value property because you shouldn't bind anything to it. Users type in the textbox, the date they settle on will be formatted in the textbox which is assigned to the value property. In addition...if you supply a valid date attribute to this textbox, it will be formatted for you. Don't go being all clever trying to do things that are already taken care of for you.
    • afterParseFail - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered only when the date parsing fails.
    • afterParseSuccess - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered only when the date parsing succeeds.
    • beforeParse - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered prior to every parsing action.
    • displayFormat - OPTIONAL, DEFAULT LL. Formatting is done using moment.js. The default format of your dates is the localized LL. You can change this however you want. See the demo.
    • endOfDay? - OPTIONAL, DEFAULT false.. When parsing dates, always set them to the last second of the day.
    • future? - OPTIONAL, DEFAULT false. If true, ambiguous dates like Sunday will be parsed as next Sunday. Note that non-ambiguous dates are not guaranteed to be in the future. Default is false.
    • past? - OPTIONAL, DEFAULT false. If true, ambiguous dates like Sunday will be parsed as last Sunday. Note that non-ambiguous dates are not guaranteed to be in the past. Default is false.
    • startOfDay? - OPTIONAL, DEFAULT false. When parsing dates, always set them to the start of the day. If set to true, this will take precedence over the endOfDay property.
    • timezone - OPTIONAL, DEFAULT moment.tz.guess(). Dates will be parsed and formatted in the specified timezone.
    • All the attributes from ember-cli-text-support-mixins' {{input-text}}. See https://github.com/cybertoothca/ember-cli-text-support-mixins#arguments
    • All the standard input attributes that apply to text boxes.

    Examples

    {{input-date date=myModel.createdOn displayFormat='llll'}}
    
    {{input-date date=someComponentProperty}}
    
    <div class='form-group'>
      <label for='js-updated-on' class='control-label'>Updated</label>
      {{input-date classNames='form-control' elementId='js-updated-on' date=anotherModel.updatedOn}}
      <p class='help-block'>Use with bootstrap!</p>
    </div>

    (Check out the demo...)

    {{input-iso8601}}

    What's iso8601? Go read: https://en.wikipedia.org/wiki/ISO_8601

    Just like {{input-date}}, {{input-iso8601}} also makes a simple textbox. It takes in user input in the form of a date that is swiftly parsed and formatted.

    Arguments
    • iso8601 - REQUIRED & MUST BE A STRING. Like the {{input-date}} component we do not use the textbox's value property and instead bind to the iso8601 attribute. This iso8601 attribute expects a String and it should be in ISO format (e.g. yyyy-MM-ddTHH:mm:ssZ).
    • value - DO NOT USE. I mention the value property because you shouldn't bind anything to it. Users type in the textbox, the date they settle on will be formatted in the textbox which is assigned to the value property. In addition...if you supply a valid date attribute to this textbox, it will be formatted for you. Don't go being all clever trying to do things that are already taken care of for you.
    • afterParseFail - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered only when the date parsing fails.
    • afterParseSuccess - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered only when the date parsing succeeds.
    • beforeParse - OPTIONAL, default undefined. Use this argument to bind an action that accepts this component as an argument. This action will be triggered prior to every parsing action.
    • displayFormat - OPTIONAL, DEFAULT LL. Formatting is done using moment.js. The default format of your dates is the localized LL. You can change this however you want. See the demo.
    • endOfDay? - OPTIONAL, DEFAULT false.. When parsing dates, always set them to the last second of the day.
    • future? - OPTIONAL, DEFAULT false. If true, ambiguous dates like Sunday will be parsed as next Sunday. Note that non-ambiguous dates are not guaranteed to be in the future. Default is false.
    • past? - OPTIONAL, DEFAULT false. If true, ambiguous dates like Sunday will be parsed as last Sunday. Note that non-ambiguous dates are not guaranteed to be in the past. Default is false.
    • startOfDay? - OPTIONAL, DEFAULT false. When parsing dates, always set them to the start of the day. If set to true, this will take precedence over the endOfDay property.
    • timezone - OPTIONAL, DEFAULT moment.tz.guess(). Dates will be parsed and formatted in the specified timezone.
    • All the attributes from ember-cli-text-support-mixins' {{input-text}}. See https://github.com/cybertoothca/ember-cli-text-support-mixins#arguments
    • All the standard input attributes that apply to text boxes.

    Examples

    {{input-iso8601 iso8601=myControllerProperty displayFormat='llll'}}
    
    <div class='form-group'>
      <label for='js-from' class='control-label'>Date From</label>
      {{input-iso8601 classNames='form-control' elementId='js-from' iso8601=anotherControllerProperty}}
      <p class='help-block'>Use with bootstrap!</p>
    </div>

    (Check out the demo...)

    Contributing

    See the Contributing guide for details.

    License

    This project is licensed under the MIT License.

    Install

    npm i ember-cli-date-textbox

    DownloadsWeekly Downloads

    203

    Version

    3.16.0

    License

    MIT

    Unpacked Size

    32.2 kB

    Total Files

    36

    Last publish

    Collaborators

    • nadnoslen