3.0.0 • Published 5 months ago

smg-date-picker v3.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
5 months ago

Installation

npm i smg-date-picker

Usage

createSMGDatePicker({
  anchorElement: Element,
  firstOutputElement: Element,
  secondOutputElement?: Element,
  mode?: CalendarMode,
  localization?: Localization,
  callback?: ((startDate: string, finishDate?: string) => void) | null
});

or

const datePicker = new SMGDatePicker({
  anchorElement: Element,
  firstOutputElement: Element,
  secondOutputElement?: Element,
  mode?: CalendarMode,
  localization?: Localization,
  callback?: ((startDate: string, finishDate?: string) => void) | null
});

datePicker.create();

Available options

  • anchorElement

This is the element which is used the smg-date-picker to be linked to. For example it might be a button element or a custom dropdown element.

  • firstOutputElement

This element is used to display selected date. In the single mode it displays the only selected date whereas in the range mode it displays selected start date.

  • secondOutputElement (optional)

This element is used to display the finish date of the selected range. This element is used only in the range mode and it is optional. In the case where the secondOutputElement is not passed to the options object, the output will be displayed on the firstOutputElement in the format "dd.mm.yyyy - dd.mm.yyyy".

  • mode (optional, default: CalendarMode.Single)

There are two modes available:

  • CalendarMode.Single
  • CalendarMode.Range

  • localization (optional, default: Localization.Eng)

There are two available options:

  • Localization.Eng for English
  • Localization.Ru for Russian

  • callback (optional)

Callback is used to handle any operations. It is invoked with the apply button. In the single mode it receives the only parameter which is referred to the selected single date. In the range mode it receives two parameters which are referred to the start and finish dates in the selected range respectively. For example it could be used in the request to the backend API.

Single mode example

import {createSMGDatePicker, CalendarMode, Localization} from 'smg-date-picker';
import 'smg-date-picker/dist/style.css';

const anchorElement = document.querySelector('.anchor');
const firstOutputElement = document.querySelector('.output');

createSMGDatePicker({
  anchorElement,
  firstOutputElement
});

or

const datePicker = new SMGDatePicker({
  anchorElement: anchorElement,
  firstOutputElement: firstOutputElement,
  mode: CalendarMode.Range,
  localization: Localization.Ru,
  callback: console.log
});

datePicker.create();

Range mode example

import {createSMGDatePicker, CalendarMode, Localization} from 'smg-date-picker';
import 'smg-date-picker/dist/style.css';

const anchorElement = document.querySelector('.anchor');
const firstOutputElement = document.querySelector('.first-output');
const secondOutputElement = document.querySelector('.second-output');

const showDates = (startDate, finishDate) => {
  console.log(startDate, finishDate);
};

createSMGDatePicker({
  anchorElement,
  firstOutputElement,
  secondOutputElement,
  mode: CalendarMode.Range;
  localization: Localization.Ru;
  callback: showDates
});

or

const datePicker = new SMGDatePicker({
  anchorElement,
  firstOutputElement,
  firstOutputElement,
  mode: CalendarMode.Range,
  localization: Localization.Ru,
  callback: showDates
});

datePicker.create();
3.0.0

5 months ago

2.0.2

7 months ago

2.0.1

8 months ago

2.0.0

8 months ago

1.0.0

8 months ago