@temporal-picker/react-router
TypeScript icon, indicating that this package has built-in type declarations

0.1.4 • Public • Published

@temporal-picker/react-router

The DatePicker (RangePicker) component base on React-Router and temporal-picker.

How to Use

Step 1.

npm i @temporal-picker/react-router

Step 2.

import { DatePicker, RangePicker } from "@temporal-picker/react-router";

function Demo() {
  return (
    <>
      <DatePicker param="date" defaultValue="2023-01-01" resetButton aria-selected="false" />
      <RangePicker
        startParam="start"
        endParam="end"
        placement="bottom-end"
        autoApply
        resetButton
        extraSelect
        presets={[
          { label: "Preset 1", start: "2023-01-01", end: "2023-02-15" },
          { label: "Preset 2", start: "2023-01-01" },
        ]}
      />
    </>
  );
}

export default Demo;

Props

export type PickerProps = {
  className?: string;
  plain?: "date" | "time" | "datetime" | "month";
  disabled?: boolean;
  readonly?: boolean;
  max?: string;
  min?: string;
  native?: boolean;
  placement?: "bottom-start" | "bottom-end";
  autoApply?: boolean;
  resetButton?: boolean;
  extraSelect?: boolean;
  customLayout?: boolean;
  firstDay?: number;
  locale?: string;
  localeApply?: string;
  localeCancel?: string;
  localeClear?: string;
  rowHeader?: boolean;
  pickLabel?: boolean;
  testId?: string;
  onViewChange?: (event: CustomEvent<ViewDetail>) => void;
};

export type PlainPickerProps = PickerProps & {
  param: string; // search param name
  defaultValue?: string;
};

export type RangePickerProps = PickerProps & {
  startParam: string; // search param name
  endParam: string; // search param name
  defaultStart?: string;
  defaultEnd?: string;
  presets?: {
    label: string;
    start?: string;
    end?: string;
  }[];
  presetPosition?: "bottom" | "left" | "right" | "top";
  tooltip?: boolean;
  strict?: boolean;
  reselect?: boolean;
};

Package Sidebar

Install

npm i @temporal-picker/react-router

Weekly Downloads

7

Version

0.1.4

License

MIT

Unpacked Size

8.9 kB

Total Files

8

Last publish

Collaborators

  • alexanderpo