Package detail

vue-bootstrap-datetimepicker

ankurk9151.2kMIT5.0.1

Vue.js date time picker component for bootstrap 4

vue, bootstrap, bootstrap-datetimepicker, vue-bootstrap-datetimepicker, datepicker, timepicker

readme

Vue Bootstrap 4 DatetimePicker

Vue.js component for eonasdan-bootstrap-datetimepicker

Demo on JSFiddle

Versions

:point_right: If you are looking for the documentation of an older version then switch to respective version branch.

Package Version	Bootstrap CSS version	Underlying Library	API Docs (same for both)
4.x	3.x	eonasdan-bootstrap-datetimepicker (Official)	Docs
5.x	4.x	pc-bootstrap4-datetimepicker (Fork)	Docs

Features

Reactive v-model value
- You can change datepicker value programmatically
Reactive config options
- You can change config options dynamically
- Component will watch for changes and apply them
- You are suggested to modify config via Vue.set
Emits all possible events
Works with vee-validate and other validation library

Requirements

Bootstrap ^4 (only css)
jQuery >=1.8.3
Moment.js ^2.22

Installation

# npm
npm install vue-bootstrap-datetimepicker --save

# Yarn
yarn add vue-bootstrap-datetimepicker

Using Webpack?

Webpack users need to configure ProvidePlugin

// webpack.config.js
plugins: [
  new webpack.ProvidePlugin({
    Vue: ['vue/dist/vue.esm.js', 'default'],
    jQuery: 'jquery',
    'window.jQuery': 'jquery',
    $: 'jquery',
    moment: 'moment',
  }),
]

Using Laravel Mix?

Update your webpack.mix.js file, ref

// webpack.mix.js
mix.autoload({
  'jquery': ['$', 'window.jQuery', 'jQuery'],
  'vue': ['Vue','window.Vue'],   
  'moment': ['moment','window.moment'],   
})

Icon Fonts missing?

Bootstrap v4 does not come with any icon fonts. You can import font-awesome v5 icons css.

// app.js
jQuery.extend(true, jQuery.fn.datetimepicker.defaults, {
  icons: {
    time: 'far fa-clock',
    date: 'far fa-calendar',
    up: 'fas fa-arrow-up',
    down: 'fas fa-arrow-down',
    previous: 'fas fa-chevron-left',
    next: 'fas fa-chevron-right',
    today: 'fas fa-calendar-check',
    clear: 'far fa-trash-alt',
    close: 'far fa-times-circle'
  }
});

Usage Example

<template>
  <div class="container">
    <div class="row">
      <div class="col-md-12">
        <date-picker v-model="date" :config="options"></date-picker>
      </div>
    </div>
  </div>
</template>

<script>
  // Import required dependencies 
  import 'bootstrap/dist/css/bootstrap.css';

  // Import this component
  import datePicker from 'vue-bootstrap-datetimepicker';

  // Import date picker css
  import 'pc-bootstrap4-datetimepicker/build/css/bootstrap-datetimepicker.css';

  export default {    
    data () {
      return {
        date: new Date(),
        options: {
          format: 'DD/MM/YYYY',
          useCurrent: false,
        }       
      }
    },
    components: {
      datePicker
    }
  }
</script>

As plugin

  import Vue from 'vue';
  import datePicker from 'vue-bootstrap-datetimepicker';
  import 'bootstrap/dist/css/bootstrap.css';
  import 'pc-bootstrap4-datetimepicker/build/css/bootstrap-datetimepicker.css';
  Vue.use(datePicker);

This will register a global component <date-picker>

Events

The component emits all available events

You can listen to them in your component like -

<date-picker v-model="date" @dp-hide="doSomethingOnHide" @dp-change="doSomethingOnChange"></date-picker>

Available props

The component accepts these props:

Attribute	Type	Default	Description
v-model / value	String / Date Object / moment / null	`null`	Set or Get date-picker value
config	Object	`{}`	Datetime picker configuration options
wrap	Boolean	`false`	Set this to true when wrapped in 'input-group'

Install in non-module environments (without webpack)

<!-- Date-picker dependencies -->
<script src="https://cdn.jsdelivr.net/npm/jquery@3.3"></script>
<script src="https://cdn.jsdelivr.net/npm/moment@2.22"></script>
<link href="https://cdn.jsdelivr.net/npm/bootstrap@4/dist/css/bootstrap.min.css" rel="stylesheet">

<!-- Date-picker itself -->
<script src="https://cdn.jsdelivr.net/npm/pc-bootstrap4-datetimepicker@4.17/build/js/bootstrap-datetimepicker.min.js"></script>
<link href="https://cdn.jsdelivr.net/npm/pc-bootstrap4-datetimepicker@4.17/build/css/bootstrap-datetimepicker.min.css" rel="stylesheet">

<!-- Vue js -->
<script src="https://cdn.jsdelivr.net/npm/vue@2.5"></script>
<!-- Lastly add this package -->
<script src="https://cdn.jsdelivr.net/npm/vue-bootstrap-datetimepicker@5"></script>
<script>
  // Initialize as global component
  Vue.component('date-picker', VueBootstrapDatetimePicker);
</script>

Run examples on your localhost

Clone this repo
You should have node-js >=6.10 and yarn >=1.x pre-installed
Install dependencies - yarn install
Run webpack dev server - yarn start
This should open the demo page at http://localhost:9000 in your default web browser

Testing

This package is using Jest and vue-test-utils for testing.
Tests can be found in __test__ folder.
Execute tests with this command - yarn test

Changelog

Please see CHANGELOG for more information what has changed recently.

Caveats

:warning: Don't pass config option as inline literal object to :config prop.

<!-- This will cause date picker to freeze -->
<date-picker v-model="card" :config="{format: 'DD/MM/YYYY'}"></date-picker>

Vue.js can not detect changes when literal object/arrays passed within template, see

License

MIT License

changelog

Changelog

5.0.1

Final version

5.0.0

Same as previous beta version but without beta dist tag

5.0.0-beta.2

Change export names

5.0.0-beta.1

Upgrade to bootstrap-4
Switch underlying library to pc-bootstrap4-datetimepicker

4.1.4

Update dependencies

4.1.3

Update dependencies

4.1.2

Internal: no longer require to use Object.assign

4.1.1

Fix: a bug where changes in config properties were not being detected

4.1.0

Add: Support for inline mode

4.0.0 (breaking)

Change:
- Component now sets the v-model value in same format as specified in config, previously it was moment string 2017-10-02T06:14:35.665Z but now it should follow the format; for example if format is DD/MM/YYYY then v-model will be like 22/10/2017
- input-class prop has been removed, you can always use Vue.js inbuilt class binding
```
<date-picker v-model="date" class="custom-input"></date-picker>
```
- Similarly name, id, placeholder and required props has been removed, you can still specify any number of attributes on component
```
<date-picker v-model="date" name="date-of-birth" id="js-date" placeholder="Select date" aria-required="true"></date-picker>
```

3.1.2

Revert: prevent double dp-change event
- This was preventing date-picker to update DOM
Fix: use as plugin
Chore: generate two dist file.
Change: dist folder is no longer part of repo. it means bower no longer supported.

3.1.1

Fix: prevent double dp-change event

3.1.0

Add: Emit all available events
- You can receive the events like this
```
<date-picker v-model="date" @dp-hide="onHide"></date-picker>
```

3.0.0

Change: DatetimePicker.vue file name to component.vue
- This may be breaking for users who were directly importing .vue file
Add: Ability to pass component name when used a plugin
Fix: Handle false value and convert them to null, #4