diff --git a/README.md b/README.md index e575fb0db9..d5d92948c6 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,10 @@ Lightweight date picker component for [React.js](http://reactjs.org). npm version - npm downloads + npm downloads -## Getting started +## Get started ```bash npm install react-day-picker diff --git a/package.json b/package.json index 9bc23a7f0a..adf794134a 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "license": "MIT", "scripts": { "build": "yarn workspaces foreach -v -t run build", - "develop": "concurrently --names \"react-day-picker,website\" \"yarn workspace react-day-picker develop\" \"yarn workspace website develop\"" + "develop": "concurrently --names react-day-picker,website,scripts \"yarn workspace react-day-picker develop\" \"yarn workspace website develop\" \"yarn workspace scripts develop\"" }, "repository": { "type": "git", @@ -22,9 +22,10 @@ }, "workspaces": [ "website", + "scripts", "packages/*" ], "devDependencies": { - "concurrently": "^5.1.0" + "concurrently": "^5.2.0" } } diff --git a/packages/react-day-picker/package.json b/packages/react-day-picker/package.json index 4534e81a06..7c394dc42e 100644 --- a/packages/react-day-picker/package.json +++ b/packages/react-day-picker/package.json @@ -26,10 +26,7 @@ "build-lib": "tsc", "build-css": "cp ./src/style.css ./dist/style.css", "build-dist": "cross-env TS_NODE_PROJECT=tsconfig.dist.json webpack", - "build": "yarn build-clean && yarn build-dist && yarn build-lib && yarn build-types && yarn build-css", - "docs": "yarn docs:markdown && yarn docs:json", - "docs:markdown": "typedoc --out ../../website/docs/api --theme ./typedoc/themes/default", - "docs:json": "typedoc --json ../../website/docs/api.json" + "build": "yarn build-clean && yarn build-dist && yarn build-lib && yarn build-types && yarn build-css" }, "files": [ "dist", @@ -37,29 +34,27 @@ "src" ], "devDependencies": { - "@babel/core": "^7.9.0", "@testing-library/jest-dom": "^5.5.0", - "@testing-library/react": "^10.0.2", + "@testing-library/react": "^10.0.4", "@types/jest": "^25.2.1", - "@types/node": "^13.13.1", + "@types/node": "^13.13.4", "@types/react": "^16.9.34", "@types/webpack": "^4.41.12", - "@typescript-eslint/eslint-plugin": "^2.29.0", - "@typescript-eslint/parser": "^2.29.0", + "@typescript-eslint/eslint-plugin": "^2.30.0", + "@typescript-eslint/parser": "^2.30.0", "cross-env": "^7.0.2", "date-fns": "^2.12.0", "debug": "^4.1.1", "eslint": "^6.8.0", + "eslint-config-prettier": "^6.11.0", "eslint-plugin-jest": "^23.8.2", - "jest": "^25.4.0", - "prettier": "^2.0.4", + "eslint-plugin-prettier": "^3.1.3", + "jest": "^25.5.4", + "prettier": "^2.0.5", "react": "^16.13.1", "react-dom": "^16.13.1", "ts-jest": "^25.4.0", - "ts-loader": "^7.0.1", - "ts-node": "^8.9.0", - "tsconfig-paths": "^3.9.0", - "tsconfig-paths-webpack-plugin": "^3.2.0", + "ts-loader": "^7.0.2", "tslib": "^1.11.1", "typescript": "^3.8.3", "webpack": "^5.0.0-beta.13", @@ -68,9 +63,5 @@ "peerDependencies": { "date-fns": "^2.12.0", "react": "^16.8.0" - }, - "dependencies": { - "eslint-config-prettier": "^6.11.0", - "eslint-plugin-prettier": "^3.1.3" } } diff --git a/packages/react-day-picker/src/components/DayPicker/DayPicker.tsx b/packages/react-day-picker/src/components/DayPicker/DayPicker.tsx index 7d120fbc99..0ff4120d44 100644 --- a/packages/react-day-picker/src/components/DayPicker/DayPicker.tsx +++ b/packages/react-day-picker/src/components/DayPicker/DayPicker.tsx @@ -7,7 +7,22 @@ import { defaultProps } from './defaults/defaultProps'; /** * Render a date picker component. * - * @param {DayPickerProps} props + * To select a day: + * + * ```jsx + * function App() { + * return ( + * + * ); + * ``` * @category Components */ export function DayPicker(props = defaultProps): JSX.Element { diff --git a/packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts b/packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts index c803b3ff91..93b46afcd7 100644 --- a/packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts +++ b/packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts @@ -17,13 +17,15 @@ import { import { DayPickerElements } from './DayPickerElements'; /** - * Names of the CSS classes for each UI element. + * An object defining the CSS class names for each [DayPicker + * element](./enumerations#daypickerelements). */ export type DayPickerClassNames = { [name in DayPickerElements]?: string; }; /** - * Inline `style` for each UI element. + * An object defining the inline style for each [DayPicker + * element](./enumerations#daypickerelements). */ export type DayPickerStyles = { [name in DayPickerElements]?: React.CSSProperties; @@ -71,17 +73,42 @@ export interface DayPickerProps { /** * Change the class names used by `DayPicker`. * - * Use this prop when you cannot style the CSS using the - * [[defaultClassNames]], for example when using CSS modules. + * Use this prop when you need to change the [default class + * names](defaultClassNames.mdx) — for example when using CSS modules. * - * ```jsx - * import { selected, disabled } from './styles.css'; - * - * ```` + * ### Example + * + * Using custom class names for the head and the caption elements. + * + * ```jsx preview + * function App() { + * const css = ` + * .salmon-head { + * color: salmon; + * } + * .purple-caption { + * font-weight: bold; + * color: purple; + * padding: 3px 0 6px 0; + * } + * `; + * return ( + * <> + * + * + * + * ); + * } + * ``` */ classNames?: DayPickerClassNames; /** - * Change the class names used for the day [[modifiers]]. + * Change the class names used for the [days modifiers](#day). */ daysClassNames?: DaysClassNames; @@ -90,11 +117,11 @@ export interface DayPickerProps { */ style?: React.CSSProperties; /** - * Inline styles to apply to the [[DayPickerElements]]. + * Change the inline styles for each [DayPicker element](./enumerations#daypickerelements). */ styles?: DayPickerStyles; /** - * Change the inline style for the day [[modifiers]]. + * Change the inline style for the [days modifiers](#day). */ daysStyles?: DaysStyles; @@ -105,24 +132,25 @@ export interface DayPickerProps { /** * The number of months to render. * - * See also [[pagedNavigation]]. + * @see pagedNavigation */ numberOfMonths?: number; /** * Allow navigation after (and including) the specified month. * - * See also [[toMonth]]. + * @see toMonth */ fromMonth?: Date; /** * Allow navigation before (and including) the specified month. * - * See also [[fromMonth]]. + * @see fromMonth */ toMonth?: Date; /** * When displaying multiple months, the navigation will be paginated - * displaying the [[numberOfMonths]] months at time instead of one. + * displaying the [numberOfMonths](#numberofmonths) months at time instead of + * one. */ pagedNavigation?: boolean; /** @@ -139,7 +167,7 @@ export interface DayPickerProps { * Display six weeks per months, regardless the month’s number of weeks. Outside * days will be always shown when setting this prop. * - * See also [[showOutsideDays]]. + * @see showOutsideDays */ fixedWeeks?: boolean; /** @@ -155,7 +183,7 @@ export interface DayPickerProps { * Show the outside days. An outside day is a day falling in the next or the * previous month. * - * See also [[enableOutsideDaysClick]]. + * @see enableOutsideDaysClick */ showOutsideDays?: boolean; /** @@ -200,7 +228,7 @@ export interface DayPickerProps { days?: DaysModifiers; /** - * A [`dateFns.Locale`](https://date-fns.org/docs/Locale) object to localize + * A locale object to localize * the user interface. */ locale?: dateFns.Locale; @@ -208,7 +236,7 @@ export interface DayPickerProps { * The text direction of the calendar. Use `ltr` for left-to-right (default) * or `rtl` for right-to-left. */ - dir?: string | undefined; + dir?: string; /** * Format the month caption text. diff --git a/packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts b/packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts index b71bf48baa..1efb58c10b 100644 --- a/packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts +++ b/packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts @@ -92,7 +92,7 @@ export type MatchDayBefore = { before: Date }; export type MatchDayAfter = { after: Date }; /** - * Matches the days between (but not including) the specified date. + * Matches the days between (but not including) the specified dates. */ export type MatchDayBetween = { after: Date; before: Date }; diff --git a/packages/react-day-picker/src/components/MonthCaption/MonthCaption.tsx b/packages/react-day-picker/src/components/MonthCaption/MonthCaption.tsx index aad63ef6bd..44f9590b37 100644 --- a/packages/react-day-picker/src/components/MonthCaption/MonthCaption.tsx +++ b/packages/react-day-picker/src/components/MonthCaption/MonthCaption.tsx @@ -4,6 +4,8 @@ import { MonthCaptionProps } from './types'; /** * Renders the caption of the month. + * + * @category Components */ export function MonthCaption(props: MonthCaptionProps): JSX.Element { const { containerProps } = getCaptionProps(props.dayPickerProps); diff --git a/packages/react-day-picker/src/components/MonthCaption/getCaptionProps.test.ts b/packages/react-day-picker/src/components/MonthCaption/getCaptionProps.test.ts index 321aa0b544..155eacd0ff 100644 --- a/packages/react-day-picker/src/components/MonthCaption/getCaptionProps.test.ts +++ b/packages/react-day-picker/src/components/MonthCaption/getCaptionProps.test.ts @@ -1,7 +1,7 @@ import { getCaptionProps } from './getCaptionProps'; import { defaultProps } from '../DayPicker/defaults/defaultProps'; import { CaptionHtmlProps } from './types'; -import { DayPickerClassNames, DayPickerProps } from 'components/DayPicker'; +import { DayPickerClassNames, DayPickerProps } from '../DayPicker'; describe('getCaptionProps', () => { it('return the container props', () => { diff --git a/packages/react-day-picker/src/components/Navigation/types.ts b/packages/react-day-picker/src/components/Navigation/types.ts index a054e18a2c..9991019678 100644 --- a/packages/react-day-picker/src/components/Navigation/types.ts +++ b/packages/react-day-picker/src/components/Navigation/types.ts @@ -11,6 +11,9 @@ export interface NavigationProps { * HTML props for the [[Navigation]]. */ export type NavigationHtmlProps = { + /** + * The props to apply to the container component + */ containerProps: { className?: string; style?: React.CSSProperties; diff --git a/packages/react-day-picker/src/hooks/useInput.ts b/packages/react-day-picker/src/hooks/useInput.ts index 3c0c80d1e7..5fb9526683 100644 --- a/packages/react-day-picker/src/hooks/useInput.ts +++ b/packages/react-day-picker/src/hooks/useInput.ts @@ -39,6 +39,8 @@ export type UseInputInputProps = { * * * ``` + * + * @category Hooks */ export function useInput( initialSelectedDay: Date | undefined, diff --git a/packages/react-day-picker/src/hooks/useModifiers.ts b/packages/react-day-picker/src/hooks/useModifiers.ts index ad66acd4a7..c310585cfb 100644 --- a/packages/react-day-picker/src/hooks/useModifiers.ts +++ b/packages/react-day-picker/src/hooks/useModifiers.ts @@ -8,7 +8,9 @@ import { getModifiersFromProps } from './modifiers-utils/getModifiersFromProps'; import { getOutsideModifier } from './modifiers-utils/getOutsideModifier'; /** - * TODO: add docs + * Get the modifiers for the specified day. + * + * @category Hooks */ export function useModifiers( day: Date, diff --git a/scripts/.prettierrc b/scripts/.prettierrc new file mode 100644 index 0000000000..1387fd0278 --- /dev/null +++ b/scripts/.prettierrc @@ -0,0 +1,6 @@ +{ + "trailingComma": "none", + "tabWidth": 2, + "semi": true, + "singleQuote": true +} diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000000..3bc805bf23 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,20 @@ +# React DayPicker scripts + +This project contains scripts used to build React DayPicker. + +## docs/start.ts + +Parse DayPicker types and produce an output that can be used from +[website](../website). + +```bash +yarn docs +``` + +## bin/prerelease.sh + +Use the prerelease script to bump the component alpha version and release it. + +```bash +./bin/prerelase.sh +``` diff --git a/scripts/prerelease.sh b/scripts/bin/prerelease.sh similarity index 86% rename from scripts/prerelease.sh rename to scripts/bin/prerelease.sh index ae52912982..7c032bf819 100755 --- a/scripts/prerelease.sh +++ b/scripts/bin/prerelease.sh @@ -5,7 +5,7 @@ cd packages/react-day-picker VERSION=`npm version prerelease --preid=alpha`; -echo 👋 This script will pre-release react-day-picker on npm. +echo 👋 This script will pre-release React DayPicker on npm. echo 🚀 Version: $VERSION echo echo 📡 Committing changes... @@ -27,5 +27,5 @@ printf "\n" git push --tags printf "\n" -echo +echo echo ✅ Done! diff --git a/scripts/docs/createProject.ts b/scripts/docs/createProject.ts new file mode 100644 index 0000000000..32bc632d3a --- /dev/null +++ b/scripts/docs/createProject.ts @@ -0,0 +1,38 @@ +import * as TS from 'typescript'; +import * as TD from 'typedoc'; + +/** + * Filename in the output directory that contains all the typings in json + * format. + */ +const ALL_FILENAME = 'all.json'; + +/** + * Create a Typedoc project and save the reflections to the output dir. + * Reflections are then returned as parsed JSON. + */ +export function createProject( + inputPath: string, + outputPath: string, + tsconfigPath: string +): TD.ProjectReflection { + const app = new TD.Application(); + + app.bootstrap({ + mode: 'file', + readme: 'none', + jsx: TS.JsxEmit.React, + esModuleInterop: true, + ignoreCompilerErrors: true, + tsconfig: tsconfigPath, + exclude: ['*.test.ts', 'node_modules'] + }); + + const project = app.convert(app.expandInputFiles([inputPath])); + + if (!project) throw new Error('Could not create a project.'); + + const allPath = `${outputPath}/${ALL_FILENAME}`; + app.generateJson(project, allPath); + return require(allPath); +} diff --git a/scripts/docs/helpers/makeDir.ts b/scripts/docs/helpers/makeDir.ts new file mode 100644 index 0000000000..acc0d517aa --- /dev/null +++ b/scripts/docs/helpers/makeDir.ts @@ -0,0 +1,7 @@ +import * as FS from 'fs'; + +export function makeDir(path: string) { + if (!FS.existsSync(path)) { + FS.mkdirSync(path); + } +} diff --git a/scripts/docs/helpers/readFile.ts b/scripts/docs/helpers/readFile.ts new file mode 100644 index 0000000000..95eb9df835 --- /dev/null +++ b/scripts/docs/helpers/readFile.ts @@ -0,0 +1,5 @@ +import * as FS from 'fs'; + +export function readFile(path: string) { + return FS.readFileSync(path).toString(); +} diff --git a/scripts/docs/helpers/reflections.ts b/scripts/docs/helpers/reflections.ts new file mode 100644 index 0000000000..5aec09c466 --- /dev/null +++ b/scripts/docs/helpers/reflections.ts @@ -0,0 +1,98 @@ +import * as TD from 'typedoc'; +import { CategoryTitle } from './types'; +import { ReflectionGroup, ReflectionCategory } from 'typedoc/dist/lib/models'; + +export function findReflection( + project: TD.ProjectReflection, + kind: TD.ReflectionKind, + categoryTitle?: CategoryTitle +) { + console.log( + 'Finding reflections with kind "%s" and category "%s"', + kind, + categoryTitle + ); + const group = ( + project.groups?.find((group: ReflectionGroup) => group.kind === kind) + ); + + let ids = []; + + if (!categoryTitle) { + ids = group.children; + } else { + const category = group.categories.find( + (cat: any) => cat.title.toLowerCase() === categoryTitle + ); + ids = category.children; + } + + const reflections = ids?.map((id: number) => { + const reflection = project!.children!.find( + (reflection: TD.Reflection) => reflection.id === id + ); + const children = reflection?.children?.map((child: any) => { + let { type } = child; + if (type?.id) { + const typeExtended = project.children?.find( + (child) => child.id === type.id + ); + const page = typeExtended?.kindString?.split(' ')[0].toLowerCase(); + const childWithType = { + ...child, + type: { ...type, page } + }; + return childWithType; + } + return child; + }); + + return { ...reflection, children }; + }); + return reflections; +} + +const mdnUrl = + 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/'; +const dateFnsUrl = 'https://date-fns.org/docs/'; + +function getLink(reflection: any) { + const { id, name } = reflection; + let link = ''; + if (id) { + link = `./types#${name.toLowerCase()}`; + } else if ( + name === 'Date' || + name === 'string' || + name === 'boolean' || + name === 'number' + ) { + link = `${mdnUrl}${name}`; + } else if (name.indexOf('dateFns') > -1) { + link = `${dateFnsUrl}${name.replace('dateFns.', '')}`; + } + return link; +} + +/** + * Parse a type reflections for the syntax template. + */ +export function parseTypeReflection( + reflection: any +): { name: string; link: string | undefined } { + const { type, name, elementType } = reflection; + switch (type) { + case 'intrinsic': + case 'reference': + return { name, link: getLink(reflection) }; + case 'array': { + const arrayType = parseTypeReflection(elementType); + return { + name: `Array<${arrayType.name}>`, + link: arrayType.link + }; + } + default: + return { name, link: undefined }; + } +} diff --git a/scripts/docs/helpers/types.ts b/scripts/docs/helpers/types.ts new file mode 100644 index 0000000000..4d2e5e7dc0 --- /dev/null +++ b/scripts/docs/helpers/types.ts @@ -0,0 +1,4 @@ +export enum CategoryTitle { + Components = 'components', + Hooks = 'hooks' +} diff --git a/scripts/docs/helpers/writeFile.ts b/scripts/docs/helpers/writeFile.ts new file mode 100644 index 0000000000..dec474fab8 --- /dev/null +++ b/scripts/docs/helpers/writeFile.ts @@ -0,0 +1,5 @@ +import * as FS from 'fs'; + +export function writeFile(path: string, content: string) { + return FS.writeFileSync(path, content); +} diff --git a/scripts/docs/start.ts b/scripts/docs/start.ts new file mode 100644 index 0000000000..60307e3f7e --- /dev/null +++ b/scripts/docs/start.ts @@ -0,0 +1,50 @@ +#!/usr/bin/env babel-node +import * as Path from 'path'; +import * as Commander from 'commander'; + +import { createProject } from './createProject'; +import { writeComponents } from './writeComponents'; +import { configure } from './templates/configure'; +import { writeEnumerations } from './writeEnumerations'; +import { writeInterfaces } from './writeInterfaces'; +import { writeTypeAliases } from './writeTypeAliases'; + +const program = new Commander.Command(); +program + .option( + '-p, --project ', + 'set the project root', + '../packages/react-day-picker' + ) + .option( + '-i, --input ', + 'set the project input files converted by typedoc', + 'src' + ) + .option( + '-c, --config ', + 'set the tsconfig.json path, relative to the project’s root', + 'tsconfig.json' + ) + .option( + '-o, --outDir ', + 'set the output directory', + '../website/docs/api' + ) + .action(() => { + const projectPath = Path.resolve(program.project); + const outputPath = Path.resolve(program.outDir); + const inputPath = Path.resolve(projectPath, program.input); + const configPath = Path.resolve(projectPath, program.config); + + configure(); + console.log('Creating project...'); + const project = createProject(inputPath, outputPath, configPath); + writeComponents(project, outputPath); + writeEnumerations(project, outputPath); + writeTypeAliases(project, outputPath); + writeInterfaces(project, outputPath); + // writeHooks(project, outputPath); + }); + +program.parse(process.argv); diff --git a/scripts/docs/templates/configure.ts b/scripts/docs/templates/configure.ts new file mode 100644 index 0000000000..340156a0ac --- /dev/null +++ b/scripts/docs/templates/configure.ts @@ -0,0 +1,93 @@ +import { registerHelper, registerPartial } from 'handlebars'; +import { resolve } from 'path'; +import { readFile } from '../helpers/readFile'; + +type LinkType = { + type: string; + id: number; + name: string; + elementType: { type: string; name: string }; +}; + +const mdnUrl = + 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/'; +const dateFnsUrl = 'https://date-fns.org/docs/'; +function getLink(reflection: any) { + const { name, page } = reflection; + let link; + if (page) { + link = `./${page}#${name.toLowerCase()}`; + } else if ( + name === 'Date' || + name === 'string' || + name === 'boolean' || + name === 'number' + ) { + link = `${mdnUrl}${name}`; + } else if (name.indexOf('dateFns') > -1) { + link = `${dateFnsUrl}${name.replace('dateFns.', '')}`; + } + return link; +} + +const partials = [ + 'prop', + 'syntax', + 'enum', + 'interface', + 'type', + 'alias', + 'declaration' +]; +const helpers = { + noBreak: (str: string | undefined) => str?.replace(/\n/g, ''), + toLowerCase: (str: string | undefined) => str?.toLowerCase(), + + replaceLinks: function (str: string | undefined) { + if (!str) return str; + + if (str.match(/\[\[/)) { + // Links in the form of [[]] are local # anchors + return str.replace( + /\[\[(\w*)\]\]/gi, + (_, p1) => `[${p1}](#${p1.toLowerCase()})` + ); + } + + return str; + }, + + linkType: function (reflection: LinkType | undefined): string { + if (!reflection) return ''; + const { type, name } = reflection; + switch (type) { + case 'intrinsic': + case 'reference': + return `[\`${name}\`](${getLink(reflection)})`; + default: + return name; + } + }, + + ifEquals: function (arg1: any, arg2: any, options: any) { + //@ts-ignore + return arg1 == arg2 ? options.fn(this) : options.inverse(this); + }, + + parseDeclaration: function (type: any): string { + return 'declaration parsed'; + } +}; + +/** + * Configure handlebars templates and helpers. + */ +export function configure() { + Object.entries(helpers).map(([name, fun]) => registerHelper(name, fun)); + partials.forEach((name) => + registerPartial( + name, + readFile(resolve(__dirname, '../templates', 'partials', `${name}.tpl`)) + ) + ); +} diff --git a/scripts/docs/templates/pages/component.tpl b/scripts/docs/templates/pages/component.tpl new file mode 100644 index 0000000000..5b1ff44d76 --- /dev/null +++ b/scripts/docs/templates/pages/component.tpl @@ -0,0 +1,20 @@ +--- +id: {{toLowerCase name}} +title: {{name}} +sidebar_label: {{name}} +--- + {{!-- Used by custom.css --}} + +{{replaceLinks comment.shortText}} + +{{#if text}}{{replaceLinks comment.text}}{{/if}} + + + +# {{name}} props + +{{#each props }} + +{{> prop this}} + +{{/each}} diff --git a/scripts/docs/templates/pages/enumerations.tpl b/scripts/docs/templates/pages/enumerations.tpl new file mode 100644 index 0000000000..65d1b743f7 --- /dev/null +++ b/scripts/docs/templates/pages/enumerations.tpl @@ -0,0 +1,12 @@ +--- +id: enumerations +title: Enumerations +sidebar_label: Enumerations +--- + {{!-- Used by custom.css --}} + +{{#each enumerations }} + +{{> enum enum=this}} + +{{/each}} diff --git a/scripts/docs/templates/pages/hook.tpl b/scripts/docs/templates/pages/hook.tpl new file mode 100644 index 0000000000..e69de29bb2 diff --git a/scripts/docs/templates/pages/interfaces.tpl b/scripts/docs/templates/pages/interfaces.tpl new file mode 100644 index 0000000000..056a114270 --- /dev/null +++ b/scripts/docs/templates/pages/interfaces.tpl @@ -0,0 +1,10 @@ +--- +id: interface +title: Interfaces +--- + {{!-- Used by custom.css --}} +{{#each interfaces }} + +{{> interface this}} + +{{/each}} diff --git a/scripts/docs/templates/pages/type-aliases.tpl b/scripts/docs/templates/pages/type-aliases.tpl new file mode 100644 index 0000000000..af0e394112 --- /dev/null +++ b/scripts/docs/templates/pages/type-aliases.tpl @@ -0,0 +1,11 @@ +--- +id: type +title: Types +--- + {{!-- Used by custom.css --}} + +{{#each aliases }} + +{{> alias this}} + +{{/each}} diff --git a/scripts/docs/templates/partials/alias.tpl b/scripts/docs/templates/partials/alias.tpl new file mode 100644 index 0000000000..c714b74112 --- /dev/null +++ b/scripts/docs/templates/partials/alias.tpl @@ -0,0 +1,5 @@ +## {{name}} + +{{#if comment.shortText}}{{replaceLinks comment.shortText}}{{/if}} + +{{#if comment.text}}{{replaceLinks comment.text}}{{/if}} diff --git a/scripts/docs/templates/partials/declaration.tpl b/scripts/docs/templates/partials/declaration.tpl new file mode 100644 index 0000000000..a867667ebe --- /dev/null +++ b/scripts/docs/templates/partials/declaration.tpl @@ -0,0 +1,2 @@ + +`{ {{#each declaration.children}} {{name}}:` {{>type type}}`, {{/each}} }` diff --git a/scripts/docs/templates/partials/enum.tpl b/scripts/docs/templates/partials/enum.tpl new file mode 100644 index 0000000000..d70fc2290d --- /dev/null +++ b/scripts/docs/templates/partials/enum.tpl @@ -0,0 +1,13 @@ +## {{enum.name}} + +{{#if enum.comment.shortText~}} + {{replaceLinks enum.comment.shortText}} +{{~/if}} + +{{#if enum.comment.text}}{{replaceLinks enum.comment.text}}{{/if}} + +|Name|Description +|----|----------- +{{#each enum.children }} +| {{defaultValue}}|{{replaceLinks (noBreak comment.shortText)}}| +{{/each}} diff --git a/scripts/docs/templates/partials/interface.tpl b/scripts/docs/templates/partials/interface.tpl new file mode 100644 index 0000000000..68f8884bc4 --- /dev/null +++ b/scripts/docs/templates/partials/interface.tpl @@ -0,0 +1,20 @@ +## {{name}} + +{{#if comment.shortText~}} + {{replaceLinks comment.shortText}} +{{~/if}} + +
+ +{{!-- {{> syntax kind="enum" name=enum.name optional=true type=enum.type }} --}} + +{{#if comment.text}}{{replaceLinks comment.text}}{{/if}} + +{{#each children }} + + +{{> syntax name=name flags=flags type=type prefix="prop" }} + +{{replaceLinks (noBreak comment.shortText) }} + +{{/each}} diff --git a/scripts/docs/templates/partials/prop.tpl b/scripts/docs/templates/partials/prop.tpl new file mode 100644 index 0000000000..671e98fb76 --- /dev/null +++ b/scripts/docs/templates/partials/prop.tpl @@ -0,0 +1,10 @@ +## {{name}} +{{#if comment.shortText~}} + {{replaceLinks comment.shortText}} +{{~/if}} + +{{> syntax prefix="prop" name=name flags=flags type=type }} + +
+ +{{#if comment.text}}{{replaceLinks comment.text}}{{/if}} diff --git a/scripts/docs/templates/partials/syntax.tpl b/scripts/docs/templates/partials/syntax.tpl new file mode 100644 index 0000000000..876976767b --- /dev/null +++ b/scripts/docs/templates/partials/syntax.tpl @@ -0,0 +1,3 @@ + + +`{{prefix}} `**`{{name}}{{#if flags.isOptional }}?{{/if}}:`** {{> type type}} diff --git a/scripts/docs/templates/partials/type.tpl b/scripts/docs/templates/partials/type.tpl new file mode 100644 index 0000000000..d90ec9a13e --- /dev/null +++ b/scripts/docs/templates/partials/type.tpl @@ -0,0 +1,13 @@ +{{~#ifEquals type "intrinsic"~}} +{{~linkType this~}} +{{~/ifEquals~}} +{{#ifEquals type "reference"~}} +{{~linkType this~}} +{{~/ifEquals~}} +{{~#ifEquals type "array"~}} +[{{~>type elementType}}] +{{~/ifEquals~}} + +{{~#ifEquals type "reflection"~}} +indexed +{{~/ifEquals~}} diff --git a/scripts/docs/writeComponents.ts b/scripts/docs/writeComponents.ts new file mode 100644 index 0000000000..3a7db20a55 --- /dev/null +++ b/scripts/docs/writeComponents.ts @@ -0,0 +1,59 @@ +import { resolve } from 'path'; +import { compile } from 'handlebars'; + +import * as TD from 'typedoc'; +import { findReflection } from './helpers/reflections'; +import { CategoryTitle } from './helpers/types'; +import { makeDir } from './helpers/makeDir'; +import { writeFile } from './helpers/writeFile'; +import { readFile } from './helpers/readFile'; + +const tplPath = resolve(__dirname, 'templates', 'pages', 'component.tpl'); +const template = compile(readFile(tplPath), { noEscape: true }); + +/** + * Write components files (functions with "@category components") + */ +export function writeComponents( + project: TD.ProjectReflection, + outputPath: string +) { + makeDir(outputPath); + + const components = findReflection( + project, + TD.ReflectionKind.Function, + CategoryTitle.Components + ); + + components.forEach((c: any) => { + const component = c.signatures[0]; + const propReflectionId = component.parameters[0].type.id; + const propReflection = project.children?.find( + (child) => child.id === propReflectionId + ); + let props = propReflection?.children; + + props = props?.map((prop: any) => { + let page; + if (prop.type.id) { + const typeExtended = project.children?.find( + (child) => child.id === prop.type.id + ); + page = typeExtended?.kindString?.split(' ')[0].toLowerCase(); + } + return { + ...prop, + type: { ...prop.type, page } + }; + }); + + const templateData = { + ...component, + props + }; + const componentPath = `${outputPath}/${component.name}.mdx`; + writeFile(componentPath, template(templateData)); + console.log(componentPath); + }); +} diff --git a/scripts/docs/writeEnumerations.ts b/scripts/docs/writeEnumerations.ts new file mode 100644 index 0000000000..483e915460 --- /dev/null +++ b/scripts/docs/writeEnumerations.ts @@ -0,0 +1,26 @@ +import { resolve } from 'path'; +import { compile } from 'handlebars'; + +import { ProjectReflection, ReflectionKind } from 'typedoc'; +import { findReflection } from './helpers/reflections'; +import { makeDir } from './helpers/makeDir'; +import { writeFile } from './helpers/writeFile'; +import { readFile } from './helpers/readFile'; + +const tplPath = resolve(__dirname, 'templates', 'pages', 'enumerations.tpl'); +const template = compile(readFile(tplPath), { noEscape: true }); + +/** + * Write components files (functions with "@category components") + */ +export function writeEnumerations( + project: ProjectReflection, + outputPath: string +) { + makeDir(outputPath); + const enumerations = findReflection(project, ReflectionKind.Enum); + const componentPath = `${outputPath}/enumerations.mdx`; + writeFile(componentPath, template({ enumerations })); + console.log('%s enumerations found', enumerations.length); + console.log(componentPath); +} diff --git a/scripts/docs/writeInterfaces.ts b/scripts/docs/writeInterfaces.ts new file mode 100644 index 0000000000..2d0d0bd63e --- /dev/null +++ b/scripts/docs/writeInterfaces.ts @@ -0,0 +1,26 @@ +import { resolve } from 'path'; +import { compile } from 'handlebars'; + +import { ProjectReflection, ReflectionKind } from 'typedoc'; +import { findReflection } from './helpers/reflections'; +import { makeDir } from './helpers/makeDir'; +import { writeFile } from './helpers/writeFile'; +import { readFile } from './helpers/readFile'; + +const tplPath = resolve(__dirname, 'templates', 'pages', 'interfaces.tpl'); +const template = compile(readFile(tplPath), { noEscape: true }); + +/** + * Write components files (functions with "@category components") + */ +export function writeInterfaces( + project: ProjectReflection, + outputPath: string +) { + makeDir(outputPath); + const interfaces = findReflection(project, ReflectionKind.Interface); + const componentPath = `${outputPath}/interface.mdx`; + + writeFile(componentPath, template({ interfaces })); + console.log(componentPath); +} diff --git a/scripts/docs/writeTypeAliases.ts b/scripts/docs/writeTypeAliases.ts new file mode 100644 index 0000000000..dbd29ad42c --- /dev/null +++ b/scripts/docs/writeTypeAliases.ts @@ -0,0 +1,27 @@ +import { resolve } from 'path'; +import { compile } from 'handlebars'; + +import { ProjectReflection, ReflectionKind } from 'typedoc'; +import { findReflection } from './helpers/reflections'; +import { makeDir } from './helpers/makeDir'; +import { writeFile } from './helpers/writeFile'; +import { readFile } from './helpers/readFile'; + +const tplPath = resolve(__dirname, 'templates', 'pages', 'type-aliases.tpl'); +const template = compile(readFile(tplPath), { noEscape: true }); + +/** + * Write components files (functions with "@category components") + */ +export function writeTypeAliases( + project: ProjectReflection, + outputPath: string +) { + makeDir(outputPath); + const aliases = findReflection(project, ReflectionKind.TypeAlias); + + const componentPath = `${outputPath}/type.mdx`; + + writeFile(componentPath, template({ aliases })); + console.log(componentPath); +} diff --git a/scripts/index.js b/scripts/index.js new file mode 100644 index 0000000000..b1d8b6de6e --- /dev/null +++ b/scripts/index.js @@ -0,0 +1,2 @@ +export * from './build/components'; +export * from './build/hooks'; diff --git a/scripts/nodemon.json b/scripts/nodemon.json new file mode 100644 index 0000000000..48045e06d7 --- /dev/null +++ b/scripts/nodemon.json @@ -0,0 +1,9 @@ +{ + "watch": [ + "docs", + "../packages/react-day-picker/src" + ], + "ext": "ts,tsx,tpl", + "ignore": [], + "exec": "yarn docs" +} diff --git a/scripts/package.json b/scripts/package.json new file mode 100644 index 0000000000..66d20b7c7a --- /dev/null +++ b/scripts/package.json @@ -0,0 +1,38 @@ +{ + "name": "scripts", + "version": "1.0.0", + "description": "Package to generate react-day-picker docs", + "main": "dist/index.js", + "scripts": { + "docs:develop": "yarn nodemon", + "docs": "yarn node -r ts-node/register ./docs/start.ts" + }, + "types": "./types", + "files": [ + "dist", + "output" + ], + "repository": { + "type": "git", + "url": "git+ssh://git@github.com/gpbl/react-day-picker.git" + }, + "author": "Giampaolo Bellavite ", + "license": "MIT", + "bugs": { + "url": "https://github.com/gpbl/react-day-picker/issues" + }, + "homepage": "https://github.com/gpbl/react-day-picker#readme", + "dependencies": { + "@mdx-js/mdx": "^1.6.1", + "@types/node": "12", + "handlebars": "^4.7.6", + "pino-pretty": "^4.0.0", + "ts-node": "^8.9.1", + "typedoc": "^0.17.6", + "typescript": "^3.8.3" + }, + "devDependencies": { + "@types/pino": "^6.0.0", + "nodemon": "^2.0.3" + } +} diff --git a/scripts/tsconfig.json b/scripts/tsconfig.json new file mode 100644 index 0000000000..0d9fffccb7 --- /dev/null +++ b/scripts/tsconfig.json @@ -0,0 +1,63 @@ +{ + "compilerOptions": { + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + // "target": "ES2016", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + "allowJs": false, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "react", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./dist", /* Redirect output structure to the directory. */ + "rootDir": "./docs", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + "removeComments": false, /* Do not emit comments to output. */ + "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + "types": [ + "node" + ], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "resolveJsonModule": true, + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + /* Advanced Options */ + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + }, +} diff --git a/website/.prettierrc b/website/.prettierrc new file mode 100644 index 0000000000..1387fd0278 --- /dev/null +++ b/website/.prettierrc @@ -0,0 +1,6 @@ +{ + "trailingComma": "none", + "tabWidth": 2, + "semi": true, + "singleQuote": true +} diff --git a/website/blog/2019-05-28-hola.md b/website/blog/2019-05-28-hola.md deleted file mode 100755 index 5552da124f..0000000000 --- a/website/blog/2019-05-28-hola.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -id: hola -title: Hola -author: Gao Wei -author_title: Docusaurus Core Team -author_url: https://github.com/wgao19 -author_image_url: https://avatars1.githubusercontent.com/u/2055384?v=4 -tags: [hola, docusaurus] ---- - -Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet diff --git a/website/blog/2019-05-29-hello-world.md b/website/blog/2019-05-29-hello-world.md deleted file mode 100755 index 3b33193938..0000000000 --- a/website/blog/2019-05-29-hello-world.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: hello-world -title: Hello -author: Endilie Yacop Sucipto -author_title: Maintainer of Docusaurus -author_url: https://github.com/endiliey -author_image_url: https://avatars1.githubusercontent.com/u/17883920?s=460&v=4 -tags: [hello, docusaurus] ---- - -Welcome to this blog. This blog is created with [**Docusaurus 2 alpha**](https://v2.docusaurus.io/). - - - -This is a test post. - -A whole bunch of other information. diff --git a/website/blog/2019-05-30-welcome.md b/website/blog/2019-05-30-welcome.md deleted file mode 100755 index 3cb4595faa..0000000000 --- a/website/blog/2019-05-30-welcome.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -id: welcome -title: Welcome -author: Yangshun Tay -author_title: Front End Engineer @ Facebook -author_url: https://github.com/yangshun -author_image_url: https://avatars0.githubusercontent.com/u/1315101?s=400&v=4 -tags: [facebook, hello, docusaurus] ---- - -Blog features are powered by the blog plugin. Simple add files to the `blog` directory. It supports tags as well! - -Delete the whole directory if you don't want the blog features. As simple as that! diff --git a/website/config/presets/classic.js b/website/config/presets/classic.js index fd1fd84341..21d76589c9 100644 --- a/website/config/presets/classic.js +++ b/website/config/presets/classic.js @@ -1,14 +1,14 @@ module.exports = [ - "@docusaurus/preset-classic", + '@docusaurus/preset-classic', { docs: { - sidebarPath: require.resolve("../../sidebars.js"), - editUrl: "https://github.com/gpbl/react-day-picker/edit/master/website/", + sidebarPath: require.resolve('../../sidebars.js'), + editUrl: 'https://github.com/gpbl/react-day-picker/edit/master/website/', showLastUpdateAuthor: false, - showLastUpdateTime: true + showLastUpdateTime: false }, theme: { - customCss: require.resolve("../../src/css/custom.css") + customCss: require.resolve('../../src/css/custom.css') } } ]; diff --git a/website/config/sidebar.js b/website/config/sidebar.js index b383220b79..24f4f85826 100644 --- a/website/config/sidebar.js +++ b/website/config/sidebar.js @@ -1,27 +1,44 @@ module.exports = [ - "start", - "examples", + 'start', + 'examples', { - type: "category", - label: "Use of modifiers", - items: ["modifiers", "modifiers-matching-days"], + type: 'category', + label: 'Use of modifiers', + items: ['modifiers', 'modifiers-matching-days'] }, { - type: "category", - label: "Guides", + type: 'category', + label: 'Guides', items: [ - "styling", - "months", - "formatting", - "localization", - "input", - "custom-components", - "upgrading", - ], + 'styling', + 'months', + 'formatting', + 'localization', + 'input', + 'custom-components', + 'upgrading' + ] }, { - type: "category", - label: "Reference", - items: ["reference/props", "reference/hooks", "reference/changelog"], - }, + type: 'category', + label: 'Reference', + items: [ + 'api/daypicker', + { + type: 'category', + label: 'Components', + items: [ + 'api/day', + 'api/monthcaption', + 'api/navigation', + 'api/weeknumber' + ] + }, + 'api/enumerations', + 'api/interface', + 'api/type', + 'reference/changelog', + 'reference/hooks' + ] + } ]; diff --git a/website/config/themeConfig/footer.js b/website/config/themeConfig/footer.js index 728a2c4c39..161c90b0df 100644 --- a/website/config/themeConfig/footer.js +++ b/website/config/themeConfig/footer.js @@ -6,44 +6,40 @@ module.exports = { items: [ { label: "Style Guide", - to: "docs/doc1" + to: "docs/doc1", }, { label: "Second Doc", - to: "docs/doc2" - } - ] + to: "docs/doc2", + }, + ], }, { title: "Community", items: [ { label: "Stack Overflow", - href: "https://stackoverflow.com/questions/tagged/react-day-picker" + href: "https://stackoverflow.com/questions/tagged/react-day-picker", }, { label: "Spectrum Chat", - href: "https://spectrum.chat/react-day-picker" - } - ] + href: "https://spectrum.chat/react-day-picker", + }, + ], }, { title: "Social", items: [ - { - label: "Blog", - to: "blog" - }, { label: "GitHub", - href: "https://github.com/gpbl/react-day-picker" + href: "https://github.com/gpbl/react-day-picker", }, { label: "Twitter", - href: "https://twitter.com/daypicker" - } - ] - } + href: "https://twitter.com/daypicker", + }, + ], + }, ], - copyright: `Copyright © ${new Date().getFullYear()} gpbl and contributors. Built with Docusaurus.` + copyright: `Copyright © ${new Date().getFullYear()} gpbl and contributors. Built with Docusaurus.`, }; diff --git a/website/config/themeConfig/index.js b/website/config/themeConfig/index.js index c137551264..680c49b783 100644 --- a/website/config/themeConfig/index.js +++ b/website/config/themeConfig/index.js @@ -1,10 +1,10 @@ -const navbar = require("./navbar"); -const footer = require("./footer"); +const navbar = require('./navbar'); +const footer = require('./footer'); module.exports = { navbar, gtag: { - trackingID: "UA-68185118-1" + trackingID: 'UA-68185118-1' }, footer }; diff --git a/website/config/themeConfig/navbar.js b/website/config/themeConfig/navbar.js index 91df6fa8a4..139060167b 100644 --- a/website/config/themeConfig/navbar.js +++ b/website/config/themeConfig/navbar.js @@ -1,20 +1,20 @@ const links = [ - { to: "docs/start", label: "Docs", position: "left" }, - { to: "docs/examples", label: "Examples", position: "left" }, - { to: "docs/reference/props", label: "Props", position: "left" }, - { to: "docs/reference/changelog", label: "Changelog", position: "left" }, + { to: 'docs/start', label: 'Docs', position: 'right' }, + { to: 'docs/examples', label: 'Examples', position: 'right' }, + { to: 'docs/api/daypicker', label: 'API', position: 'right' }, + { to: 'docs/reference/changelog', label: 'Changelog', position: 'right' }, { - href: "https://github.com/gpbl/react-day-picker", - label: "GitHub", - position: "right", - }, + href: 'https://github.com/gpbl/react-day-picker', + label: 'GitHub', + position: 'right' + } ]; module.exports = { - title: "React DayPicker", + title: 'React DayPicker', logo: { - alt: "DayPicker Logo", - src: "img/logo.svg", + alt: 'DayPicker Logo', + src: 'img/logo.png' }, - links, + links }; diff --git a/website/docs/api/Day.mdx b/website/docs/api/Day.mdx new file mode 100644 index 0000000000..ab2ec25763 --- /dev/null +++ b/website/docs/api/Day.mdx @@ -0,0 +1,49 @@ +--- +id: day +title: Day +sidebar_label: Day +--- + + +The `Day` component renders the content of the day cell. It renders a button +if the day is interactive (i.e. it is clickable). + + + + + +# Day props + + +## currentMonth +The month the calendar belongs to. Used to calulate outside days. + + +`prop `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## day +The day to display in the calendar. + + +`prop `**`day:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## dayPickerProps +Reference to the props used by the DayPicker component. + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + diff --git a/website/docs/api/DayPicker.mdx b/website/docs/api/DayPicker.mdx new file mode 100644 index 0000000000..e773201026 --- /dev/null +++ b/website/docs/api/DayPicker.mdx @@ -0,0 +1,465 @@ +--- +id: daypicker +title: DayPicker +sidebar_label: DayPicker +--- + + +Render a date picker component. + + + + + +# DayPicker props + + +## className +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./type#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./type#customcomponents) + +
+ + + + +## days +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./type#daysmodifiers) + +
+ + + + +## daysClassNames +Change the class names used for the [days modifiers](#day). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./type#daysclassnames) + +
+ + + + +## daysStyles +Change the inline style for the [days modifiers](#day). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./type#daysstyles) + +
+ + + + +## dir +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## enableOutsideDaysClick +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./type#monthcaptionformatter) + +
+ + + + +## formatDay +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./type#dayformatter) + +
+ + + + +## formatWeekNumber +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./type#weeknumberformatter) + +
+ + + + +## formatWeekdayName +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./type#weekdaynameformatter) + +
+ + + + +## fromMonth +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## initialMonth +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./type#dayclickeventhandler) + +
+ + + + +## onMonthChange +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## onNextClick +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## onPrevClick +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## pagedNavigation +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## showCaption +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles +Change the inline styles for each [DayPicker element](./enumerations#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./type#daypickerstyles) + +
+ + + + +## toMonth +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + diff --git a/website/docs/api/Head.mdx b/website/docs/api/Head.mdx new file mode 100644 index 0000000000..d0dca55c2d --- /dev/null +++ b/website/docs/api/Head.mdx @@ -0,0 +1,49 @@ +--- +id: head +title: Head +sidebar_label: Head +--- + + +Render the head of the month table, including the weekday names (Mon, Tue, +etc.). + + + + + +# Head props + + +## dayPickerProps +Reference to the props used by the DayPicker component. + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + + +## locale + + + +`prop `**`locale:`** [`DateFns.Locale`](undefined) + +
+ + + + +## showWeekNumber +Add a column to accommodate the week numbers. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + diff --git a/website/docs/api/MonthCaption.mdx b/website/docs/api/MonthCaption.mdx new file mode 100644 index 0000000000..0dc603a608 --- /dev/null +++ b/website/docs/api/MonthCaption.mdx @@ -0,0 +1,37 @@ +--- +id: monthcaption +title: MonthCaption +sidebar_label: MonthCaption +--- + + +Renders the caption of the month. + + + + + +# MonthCaption props + + +## dayPickerProps +Reference to the props used by the DayPicker component. + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + + +## month +The month the caption is referring to. + + +`prop `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + diff --git a/website/docs/api/MonthTable.mdx b/website/docs/api/MonthTable.mdx new file mode 100644 index 0000000000..07021a4ebe --- /dev/null +++ b/website/docs/api/MonthTable.mdx @@ -0,0 +1,37 @@ +--- +id: monthtable +title: MonthTable +sidebar_label: MonthTable +--- + + +Render the month table. + + + + + +# MonthTable props + + +## dayPickerProps + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + + +## month + + + +`prop `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + diff --git a/website/docs/api/Months.mdx b/website/docs/api/Months.mdx new file mode 100644 index 0000000000..3675bfd38a --- /dev/null +++ b/website/docs/api/Months.mdx @@ -0,0 +1,465 @@ +--- +id: months +title: Months +sidebar_label: Months +--- + + +Render the months and the navigation. + + + + + +# Months props + + +## className +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./type#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./type#customcomponents) + +
+ + + + +## days +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./type#daysmodifiers) + +
+ + + + +## daysClassNames +Change the class names used for the [days modifiers](#day). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./type#daysclassnames) + +
+ + + + +## daysStyles +Change the inline style for the [days modifiers](#day). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./type#daysstyles) + +
+ + + + +## dir +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## enableOutsideDaysClick +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./type#monthcaptionformatter) + +
+ + + + +## formatDay +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./type#dayformatter) + +
+ + + + +## formatWeekNumber +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./type#weeknumberformatter) + +
+ + + + +## formatWeekdayName +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./type#weekdaynameformatter) + +
+ + + + +## fromMonth +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## initialMonth +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./type#dayclickeventhandler) + +
+ + + + +## onMonthChange +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## onNextClick +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## onPrevClick +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +
+ + + + +## pagedNavigation +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./type#daymatcher) + +
+ + + + +## showCaption +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles +Change the inline styles for each [DayPicker element](./enumerations#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./type#daypickerstyles) + +
+ + + + +## toMonth +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + diff --git a/website/docs/api/Navigation.mdx b/website/docs/api/Navigation.mdx new file mode 100644 index 0000000000..1ec7f776c4 --- /dev/null +++ b/website/docs/api/Navigation.mdx @@ -0,0 +1,26 @@ +--- +id: navigation +title: Navigation +sidebar_label: Navigation +--- + + +Renders the buttons to navigate between months. + + + + + +# Navigation props + + +## dayPickerProps + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + diff --git a/website/docs/api/WeekNumber.mdx b/website/docs/api/WeekNumber.mdx new file mode 100644 index 0000000000..5d0bd58d2a --- /dev/null +++ b/website/docs/api/WeekNumber.mdx @@ -0,0 +1,48 @@ +--- +id: weeknumber +title: WeekNumber +sidebar_label: WeekNumber +--- + + +Render the number of the week when [showWeekNumber](#showweeknumber) is enabled. + + + + + +# WeekNumber props + + +## dayPickerProps + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + + +## days + + + +`prop `**`days:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + +
+ + + + +## number + + + +`prop `**`number:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + diff --git a/website/docs/api/WeekRow.mdx b/website/docs/api/WeekRow.mdx new file mode 100644 index 0000000000..407db4da89 --- /dev/null +++ b/website/docs/api/WeekRow.mdx @@ -0,0 +1,59 @@ +--- +id: weekrow +title: WeekRow +sidebar_label: WeekRow +--- + + +Render a week row. + + + + + +# WeekRow props + + +## currentMonth + + + +`prop `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## dayPickerProps + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +
+ + + + +## week + + + +`prop `**`week:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + +
+ + + + +## weekNumber + + + +`prop `**`weekNumber:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + diff --git a/website/docs/api/all.json b/website/docs/api/all.json new file mode 100644 index 0000000000..419d31261b --- /dev/null +++ b/website/docs/api/all.json @@ -0,0 +1,11442 @@ +{ + "id": 0, + "name": "react-day-picker", + "kind": 0, + "flags": {}, + "originalName": "", + "children": [ + { + "id": 190, + "name": "DayPickerElements", + "kind": 4, + "kindString": "Enumeration", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "List of the name of the DOM elements interface elements." + }, + "children": [ + { + "id": 192, + "name": "CAPTION", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 6, + "character": 9 + } + ], + "defaultValue": "\"caption\"" + }, + { + "id": 193, + "name": "DAY", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 7, + "character": 5 + } + ], + "defaultValue": "\"day\"" + }, + { + "id": 194, + "name": "DAYWRAPPER", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 8, + "character": 12 + } + ], + "defaultValue": "\"dayWrapper\"" + }, + { + "id": 196, + "name": "DISABLED", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 11, + "character": 10 + } + ], + "defaultValue": "\"disabled\"" + }, + { + "id": 204, + "name": "HEAD", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 21, + "character": 6 + } + ], + "defaultValue": "\"head\"" + }, + { + "id": 205, + "name": "HEADROW", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 22, + "character": 9 + } + ], + "defaultValue": "\"headRow\"" + }, + { + "id": 207, + "name": "HEADWEEKNAME", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 24, + "character": 14 + } + ], + "defaultValue": "\"headWeekName\"" + }, + { + "id": 206, + "name": "HEADWEEKNUMBER", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 23, + "character": 16 + } + ], + "defaultValue": "\"headWeekNumber\"" + }, + { + "id": 200, + "name": "MONTH", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 16, + "character": 7 + } + ], + "defaultValue": "\"month\"" + }, + { + "id": 203, + "name": "MONTHS", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 19, + "character": 8 + } + ], + "defaultValue": "\"months\"" + }, + { + "id": 201, + "name": "MONTHTABLE", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 17, + "character": 12 + } + ], + "defaultValue": "\"monthTable\"" + }, + { + "id": 202, + "name": "MONTHTBODY", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 18, + "character": 12 + } + ], + "defaultValue": "\"monthTbody\"" + }, + { + "id": 208, + "name": "NAV", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Container of [[Navigation]]." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 28, + "character": 5 + } + ], + "defaultValue": "\"nav\"" + }, + { + "id": 210, + "name": "NAVNEXT", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "\"Next Month\" button in [[Navigation]]." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 36, + "character": 9 + } + ], + "defaultValue": "\"navNext\"" + }, + { + "id": 209, + "name": "NAVPREV", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "\"Previous Month\" button in [[Navigation]]." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 32, + "character": 9 + } + ], + "defaultValue": "\"navPrev\"" + }, + { + "id": 199, + "name": "OUTSIDE_END", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 14, + "character": 13 + } + ], + "defaultValue": "\"aftermonth\"" + }, + { + "id": 198, + "name": "OUTSIDE_START", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 13, + "character": 15 + } + ], + "defaultValue": "\"beforemonth\"" + }, + { + "id": 191, + "name": "ROOT", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 5, + "character": 6 + } + ], + "defaultValue": "\"root\"" + }, + { + "id": 195, + "name": "SELECTED", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 10, + "character": 10 + } + ], + "defaultValue": "\"selected\"" + }, + { + "id": 197, + "name": "TODAY", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 12, + "character": 7 + } + ], + "defaultValue": "\"today\"" + }, + { + "id": 211, + "name": "WEEK", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 38, + "character": 6 + } + ], + "defaultValue": "\"week\"" + }, + { + "id": 213, + "name": "WEEKDAY", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 40, + "character": 9 + } + ], + "defaultValue": "\"weekDay\"" + }, + { + "id": 214, + "name": "WEEKNUMBER", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The weeknumber" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 42, + "character": 12 + } + ], + "defaultValue": "\"weekNumber\"" + }, + { + "id": 212, + "name": "WEEKWEEKNUMBER", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 39, + "character": 16 + } + ], + "defaultValue": "\"weekWeeknumber\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 192, + 193, + 194, + 196, + 204, + 205, + 207, + 206, + 200, + 203, + 201, + 202, + 208, + 210, + 209, + 199, + 198, + 191, + 195, + 197, + 211, + 213, + 214, + 212 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerElements.ts", + "line": 4, + "character": 29 + } + ] + }, + { + "id": 145, + "name": "DefaultModifiersNames", + "kind": 4, + "kindString": "Enumeration", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "List the names of the default modifiers." + }, + "children": [ + { + "id": 149, + "name": "AFTER_MONTH", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is outside." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 38, + "character": 13 + } + ], + "defaultValue": "\"aftermonth\"" + }, + { + "id": 150, + "name": "BEFORE_MONTH", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is outside." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 42, + "character": 14 + } + ], + "defaultValue": "\"beforemonth\"" + }, + { + "id": 146, + "name": "DISABLED", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is disabled." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 26, + "character": 10 + } + ], + "defaultValue": "\"disabled\"" + }, + { + "id": 147, + "name": "HIDDEN", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is hidden." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 30, + "character": 8 + } + ], + "defaultValue": "\"hidden\"" + }, + { + "id": 148, + "name": "INTERACTIVE", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is interactive." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 34, + "character": 13 + } + ], + "defaultValue": "\"interactive\"" + }, + { + "id": 151, + "name": "SELECTED", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is selected." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 46, + "character": 10 + } + ], + "defaultValue": "\"selected\"" + }, + { + "id": 152, + "name": "TODAY", + "kind": 16, + "kindString": "Enumeration member", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day is today." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 50, + "character": 7 + } + ], + "defaultValue": "\"today\"" + } + ], + "groups": [ + { + "title": "Enumeration members", + "kind": 16, + "children": [ + 149, + 150, + 146, + 147, + 148, + 151, + 152 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 22, + "character": 33 + } + ] + }, + { + "id": 215, + "name": "DayPickerProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The props used by the [[DayPicker]] component." + }, + "children": [ + { + "id": 216, + "name": "className", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "CSS class to add to the root element." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 72, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 217, + "name": "classNames", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Change the class names used by `DayPicker`.", + "text": "Use this prop when you need to change the [default class\nnames](defaultClassNames.mdx) — for example when using CSS modules.\n\n### Example\n\nUsing custom class names for the head and the caption elements.\n\n```jsx preview\n function App() {\n const css = `\n .salmon-head {\n color: salmon;\n }\n .purple-caption {\n font-weight: bold;\n color: purple;\n padding: 3px 0 6px 0;\n }\n `;\n return (\n <>\n \n \n \n );\n }\n```\n" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 109, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 253, + "name": "DayPickerClassNames" + } + }, + { + "id": 248, + "name": "components", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Customize the internal components." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 269, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 268, + "name": "CustomComponents" + } + }, + { + "id": 241, + "name": "days", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "An object of modifiers." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 228, + "character": 6 + } + ], + "type": { + "type": "reference", + "id": 160, + "name": "DaysModifiers" + } + }, + { + "id": 218, + "name": "daysClassNames", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Change the class names used for the [days modifiers](#day)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 113, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 154, + "name": "DaysClassNames" + } + }, + { + "id": 221, + "name": "daysStyles", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Change the inline style for the [days modifiers](#day)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 126, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 158, + "name": "DaysStyles" + } + }, + { + "id": 243, + "name": "dir", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "The text direction of the calendar. Use `ltr` for left-to-right (default)\nor `rtl` for right-to-left." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 239, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 239, + "name": "disabled", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Disable the matching days. Disabled days cannot be clicked." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 220, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + }, + { + "id": 233, + "name": "enableOutsideDaysClick", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Enable click event for outside days when [[showOutsideDays]] is used." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 192, + "character": 24 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 229, + "name": "fixedWeeks", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Display six weeks per months, regardless the month’s number of weeks. Outside\ndays will be always shown when setting this prop.", + "tags": [ + { + "tag": "see", + "text": "showOutsideDays\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 172, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 244, + "name": "formatCaption", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Format the month caption text.", + "tags": [ + { + "tag": "default", + "text": "See [[defaultFormatCaption]].\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 246, + "character": 15 + } + ], + "type": { + "type": "reference", + "id": 58, + "name": "MonthCaptionFormatter" + } + }, + { + "id": 245, + "name": "formatDay", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Format the content of the day element.", + "tags": [ + { + "tag": "default", + "text": "See [[defaultFormatDay]].\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 252, + "character": 11 + } + ], + "type": { + "type": "reference", + "id": 75, + "name": "DayFormatter" + } + }, + { + "id": 247, + "name": "formatWeekNumber", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Format the week numbers (when [[showWeekNumber]] is set).", + "tags": [ + { + "tag": "default", + "text": "See [[defaultFormatWeekNumber]].\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 264, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 135, + "name": "WeekNumberFormatter" + } + }, + { + "id": 246, + "name": "formatWeekdayName", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Format the weekday's name in the head element.", + "tags": [ + { + "tag": "default", + "text": "See [[defaultFormatWeekdayName]].\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 258, + "character": 19 + } + ], + "type": { + "type": "reference", + "id": 17, + "name": "WeekdayNameFormatter" + } + }, + { + "id": 224, + "name": "fromMonth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Allow navigation after (and including) the specified month.", + "tags": [ + { + "tag": "see", + "text": "toMonth\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 143, + "character": 11 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 240, + "name": "hidden", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Hide the matching days." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 224, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + }, + { + "id": 222, + "name": "initialMonth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "The initial month to show in the calendar." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 131, + "character": 14 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 242, + "name": "locale", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "A locale object to localize\nthe user interface." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 234, + "character": 8 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + }, + { + "id": 228, + "name": "month", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "The rendered month. Implement [[onMonthChange]] to enable months\nnavigation." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 165, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 237, + "name": "nextLabel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Label used for the next month button in [[Navigation]]. Set it to empty\nstring to hide the button." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 211, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 223, + "name": "numberOfMonths", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "The number of months to render.", + "tags": [ + { + "tag": "see", + "text": "pagedNavigation\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 137, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 249, + "name": "onDayClick", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Event handler when the user clicks on a day." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 274, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 257, + "name": "DayClickEventHandler" + } + }, + { + "id": 250, + "name": "onMonthChange", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Event handler when the month changes." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 278, + "character": 15 + } + ], + "type": { + "type": "reference", + "id": 263, + "name": "MonthChangeEventHandler" + } + }, + { + "id": 251, + "name": "onNextClick", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Event handler when the next month button is clicked." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 282, + "character": 13 + } + ], + "type": { + "type": "reference", + "id": 263, + "name": "MonthChangeEventHandler" + } + }, + { + "id": 252, + "name": "onPrevClick", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Event handler when the previous month button is clicked." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 286, + "character": 13 + } + ], + "type": { + "type": "reference", + "id": 263, + "name": "MonthChangeEventHandler" + } + }, + { + "id": 226, + "name": "pagedNavigation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "When displaying multiple months, the navigation will be paginated\ndisplaying the [numberOfMonths](#numberofmonths) months at time instead of\none." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 155, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 236, + "name": "prevLabel", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Label used for the previous month button in [[Navigation]]. Set it to\nempty string to hide the button." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 206, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 227, + "name": "reverseMonths", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Render the months in reversed order. Useful when [[numberOfMonths]] is\ngreater than `1`, to display the most recent month first." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 160, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 238, + "name": "selected", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Apply the `selected` modifiers to the matching days." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 216, + "character": 10 + } + ], + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + }, + { + "id": 230, + "name": "showCaption", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Show the month’s caption. As default, the caption displays month and year." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 176, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 231, + "name": "showHead", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Show the month’s head. As default, it displays the weekday names according\nto [[locale]]." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 181, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 235, + "name": "showNavigation", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Show the navigation bar. [[onMonthChange]] must be set." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 201, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 232, + "name": "showOutsideDays", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Show the outside days. An outside day is a day falling in the next or the\nprevious month.", + "tags": [ + { + "tag": "see", + "text": "enableOutsideDaysClick\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 188, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 234, + "name": "showWeekNumber", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Show the week numbers column." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 196, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 219, + "name": "style", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Style to apply to the root element." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 118, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + }, + { + "id": 220, + "name": "styles", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Change the inline styles for each [DayPicker element](./enumerations#daypickerelements)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 122, + "character": 8 + } + ], + "type": { + "type": "reference", + "id": 255, + "name": "DayPickerStyles" + } + }, + { + "id": 225, + "name": "toMonth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Allow navigation before (and including) the specified month.", + "tags": [ + { + "tag": "see", + "text": "fromMonth\n" + } + ] + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 149, + "character": 9 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 216, + 217, + 248, + 241, + 218, + 221, + 243, + 239, + 233, + 229, + 244, + 245, + 247, + 246, + 224, + 240, + 222, + 242, + 228, + 237, + 223, + 249, + 250, + 251, + 252, + 226, + 236, + 227, + 238, + 230, + 231, + 235, + 232, + 234, + 219, + 220, + 225 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 68, + "character": 31 + } + ] + }, + { + "id": 71, + "name": "DayProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The props used by the [[Day]] component." + }, + "children": [ + { + "id": 73, + "name": "currentMonth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The month the calendar belongs to. Used to calulate outside days." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 15, + "character": 14 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 72, + "name": "day", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The day to display in the calendar." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 11, + "character": 5 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 74, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Reference to the props used by the DayPicker component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 19, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 73, + 72, + 74 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 7, + "character": 25 + } + ] + }, + { + "id": 5, + "name": "HeadProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The props used by the [[Head]] component." + }, + "children": [ + { + "id": 8, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Reference to the props used by the DayPicker component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/types.ts", + "line": 16, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + }, + { + "id": 6, + "name": "locale", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/types.ts", + "line": 8, + "character": 8 + } + ], + "type": { + "type": "reference", + "name": "DateFns.Locale" + } + }, + { + "id": 7, + "name": "showWeekNumber", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true, + "isOptional": true + }, + "comment": { + "shortText": "Add a column to accommodate the week numbers." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/types.ts", + "line": 12, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 8, + 6, + 7 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/types.ts", + "line": 7, + "character": 26 + } + ] + }, + { + "id": 49, + "name": "MonthCaptionProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The props used by the [[MonthCaption]] component." + }, + "children": [ + { + "id": 51, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Reference to the props used by the DayPicker component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 24, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + }, + { + "id": 50, + "name": "month", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The month the caption is referring to." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 20, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 51, + 50 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 16, + "character": 34 + } + ] + }, + { + "id": 43, + "name": "MonthTableProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props of the [[Month]] component." + }, + "children": [ + { + "id": 45, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/types.ts", + "line": 8, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + }, + { + "id": 44, + "name": "month", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/types.ts", + "line": 7, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 45, + 44 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/types.ts", + "line": 6, + "character": 32 + } + ] + }, + { + "id": 102, + "name": "NavigationProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props for the [[Navigation]] component." + }, + "children": [ + { + "id": 103, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 7, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 103 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 6, + "character": 32 + } + ] + }, + { + "id": 131, + "name": "WeekNumberProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props for the [[WeekNumber]] component." + }, + "children": [ + { + "id": 134, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 10, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + }, + { + "id": 133, + "name": "days", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 9, + "character": 6 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + }, + { + "id": 132, + "name": "number", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 8, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 134, + 133, + 132 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 7, + "character": 32 + } + ] + }, + { + "id": 12, + "name": "WeekRowProps", + "kind": 256, + "kindString": "Interface", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": {}, + "children": [ + { + "id": 14, + "name": "currentMonth", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 11, + "character": 14 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 16, + "name": "dayPickerProps", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 13, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + }, + { + "id": 15, + "name": "week", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 12, + "character": 6 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + }, + { + "id": 13, + "name": "weekNumber", + "kind": 1024, + "kindString": "Property", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 9, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "kind": 1024, + "children": [ + 14, + 16, + 15, + 13 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 8, + "character": 29 + } + ] + }, + { + "id": 52, + "name": "CaptionHtmlProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props for the #{}" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 7, + "character": 28 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 53, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 54, + "name": "containerProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 8, + "character": 16 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 55, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 56, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 9, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 57, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 10, + "character": 9 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 56, + 57 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 8, + "character": 17 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 54 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 7, + "character": 30 + } + ] + } + } + }, + { + "id": 268, + "name": "CustomComponents", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Components that can be replaced" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 54, + "character": 28 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 269, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 271, + "name": "Day", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A [[Day]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 58, + "character": 5 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 71, + "name": "DayProps" + } + ], + "name": "React.ComponentType" + } + }, + { + "id": 270, + "name": "MonthCaption", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A [[MonthCaption]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 56, + "character": 14 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 49, + "name": "MonthCaptionProps" + } + ], + "name": "React.ComponentType" + } + }, + { + "id": 272, + "name": "Navigation", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A [[Navigation]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 60, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 102, + "name": "NavigationProps" + } + ], + "name": "React.ComponentType" + } + }, + { + "id": 273, + "name": "WeekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A [[WeekNumber]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 62, + "character": 12 + } + ], + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "id": 131, + "name": "WeekNumberProps" + } + ], + "name": "React.ComponentType" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 271, + 270, + 272, + 273 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 54, + "character": 30 + } + ] + } + } + }, + { + "id": 257, + "name": "DayClickEventHandler", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Event handler when a day is clicked." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 37, + "character": 32 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 258, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 259, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 260, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 261, + "name": "modifiers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 165, + "name": "MatchingModifiers" + } + }, + { + "id": 262, + "name": "e", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "MouseEvent" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 37, + "character": 34 + } + ] + } + } + }, + { + "id": 82, + "name": "DayContainerHtmlProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 30, + "character": 33 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 83, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 84, + "name": "aria-disabled", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 31, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 85, + "name": "aria-hidden", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 32, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 91, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 35, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "disabled", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 33, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 87, + "name": "onClick", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 34, + "character": 9 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 89, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 90, + "name": "e", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "reference", + "name": "HTMLButtonElement" + } + ], + "name": "MouseEvent" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 34, + "character": 11 + } + ] + } + } + }, + { + "id": 92, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 36, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 84, + 85, + 91, + 86, + 87, + 92 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 30, + "character": 35 + } + ] + } + } + }, + { + "id": 75, + "name": "DayFormatter", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A function that format the day for the [[Day]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 25, + "character": 24 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 76, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 77, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 78, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 79, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 80, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 81, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 27, + "character": 20 + } + ], + "type": { + "type": "reference", + "name": "DateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 81 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 27, + "character": 11 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 25, + "character": 26 + } + ] + } + } + }, + { + "id": 97, + "name": "DayHtmlProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 44, + "character": 24 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 98, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 99, + "name": "containerProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 45, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 82, + "name": "DayContainerHtmlProps" + } + }, + { + "id": 101, + "name": "modifiers", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 47, + "character": 11 + } + ], + "type": { + "type": "reference", + "id": 165, + "name": "MatchingModifiers" + } + }, + { + "id": 100, + "name": "wrapperProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 46, + "character": 14 + } + ], + "type": { + "type": "reference", + "id": 93, + "name": "DayWrapperHtmlProps" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 99, + 101, + 100 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 44, + "character": 26 + } + ] + } + } + }, + { + "id": 164, + "name": "DayMatchModifier", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A type to indicate when a day matches a modifier." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 63, + "character": 28 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + { + "id": 189, + "name": "DayMatcher", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Day matchers are used to find if a day matches a specific condition, like\nbeing between two dates, or in a specified day of the week, etc." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 113, + "character": 22 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 167, + "name": "MatchDate" + }, + { + "type": "reference", + "id": 168, + "name": "MatchDayInRange" + }, + { + "type": "reference", + "id": 178, + "name": "MatchDayBetween" + }, + { + "type": "reference", + "id": 172, + "name": "MatchDayBefore" + }, + { + "type": "reference", + "id": 175, + "name": "MatchDayAfter" + }, + { + "type": "reference", + "id": 182, + "name": "MatchDaysOfWeek" + }, + { + "type": "reference", + "id": 185, + "name": "MatchFunction" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ] + } + }, + { + "id": 153, + "name": "DayModifier", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A modifier is a string attached to a day whose behavior and appearance is meant to be modified by it." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 4, + "character": 23 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 253, + "name": "DayPickerClassNames", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "An object defining the CSS class names for each [DayPicker\nelement](./enumerations#daypickerelements)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 23, + "character": 31 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 254, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 23, + "character": 33 + } + ] + } + } + }, + { + "id": 255, + "name": "DayPickerStyles", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "An object defining the inline style for each [DayPicker\nelement](./enumerations#daypickerelements)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 30, + "character": 27 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 256, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 30, + "character": 29 + } + ] + } + } + }, + { + "id": 93, + "name": "DayWrapperHtmlProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 39, + "character": 31 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 94, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 95, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 40, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 96, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 41, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 95, + 96 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/types.ts", + "line": 39, + "character": 33 + } + ] + } + } + }, + { + "id": 154, + "name": "DaysClassNames", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": {}, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 8, + "character": 26 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 155, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "indexSignature": [ + { + "id": 156, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 157, + "name": "other", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 8, + "character": 28 + } + ] + } + } + }, + { + "id": 160, + "name": "DaysModifiers", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Modifiers to assign when a day is matched." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 56, + "character": 25 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 161, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "indexSignature": [ + { + "id": 162, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 163, + "name": "modifier", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 56, + "character": 27 + } + ] + } + } + }, + { + "id": 158, + "name": "DaysStyles", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Inline styles to apply to the day element having the specified modifier." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 15, + "character": 22 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 159, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 15, + "character": 24 + } + ] + } + } + }, + { + "id": 167, + "name": "MatchDate", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches a day that is the same as the specified date." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 77, + "character": 21 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 175, + "name": "MatchDayAfter", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches the days after (but not including) the specified date." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 92, + "character": 25 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 176, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 177, + "name": "after", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 92, + "character": 35 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 177 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 92, + "character": 27 + } + ] + } + } + }, + { + "id": 172, + "name": "MatchDayBefore", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches the days before (but not including) the specified date." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 87, + "character": 26 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 173, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 174, + "name": "before", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 87, + "character": 37 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 174 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 87, + "character": 28 + } + ] + } + } + }, + { + "id": 178, + "name": "MatchDayBetween", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches the days between (but not including) the specified dates." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 97, + "character": 27 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 179, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 180, + "name": "after", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 97, + "character": 37 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 181, + "name": "before", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 97, + "character": 51 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 180, + 181 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 97, + "character": 29 + } + ] + } + } + }, + { + "id": 168, + "name": "MatchDayInRange", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches the days that are inside (but not including) the specified range." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 82, + "character": 27 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 169, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 170, + "name": "from", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 82, + "character": 36 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 171, + "name": "to", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 82, + "character": 46 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 170, + 171 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 82, + "character": 29 + } + ] + } + } + }, + { + "id": 182, + "name": "MatchDaysOfWeek", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches one or more days of the week (`0` = Sundays)." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 102, + "character": 27 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 183, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 184, + "name": "daysOfWeek", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 102, + "character": 42 + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "number" + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 184 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 102, + "character": 29 + } + ] + } + } + }, + { + "id": 185, + "name": "MatchFunction", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Matches any day for which this function returns a truthy value." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 107, + "character": 25 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 186, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 187, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 188, + "name": "date", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 107, + "character": 27 + } + ] + } + } + }, + { + "id": 165, + "name": "MatchingModifiers", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "An object containing modifiers matching a specific day. Some defaults\nmodifiers are used in `DayPicker`. They can be extended using the\n[[DayPickerProps.days]] prop." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 70, + "character": 29 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 166, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/Modifiers.ts", + "line": 70, + "character": 31 + } + ] + } + } + }, + { + "id": 58, + "name": "MonthCaptionFormatter", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "A function that format a month for the [[MonthCaption]] component." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 29, + "character": 33 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 59, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 60, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 61, + "name": "month", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 62, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 63, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 64, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 31, + "character": 20 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 64 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 31, + "character": 11 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/types.ts", + "line": 29, + "character": 35 + } + ] + } + } + }, + { + "id": 263, + "name": "MonthChangeEventHandler", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Event handler when the month is changed." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 46, + "character": 35 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 264, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 265, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 266, + "name": "month", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 267, + "name": "e", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "MouseEvent" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/types/DayPickerProps.ts", + "line": 46, + "character": 37 + } + ] + } + } + }, + { + "id": 35, + "name": "MonthWeeks", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The weeks belonging to a month. Each key of the returned object is the\nweek number of the year." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/getWeeks.ts", + "line": 19, + "character": 15 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 36, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "indexSignature": [ + { + "id": 37, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 38, + "name": "weeknumber", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/getWeeks.ts", + "line": 19, + "character": 17 + } + ] + } + } + }, + { + "id": 104, + "name": "NavigationHtmlProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "HTML props for the [[Navigation]]." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 13, + "character": 31 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 105, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 106, + "name": "containerProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The props to apply to the container component" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 17, + "character": 16 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 107, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 108, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 18, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 109, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 19, + "character": 9 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 108, + 109 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 17, + "character": 17 + } + ] + } + } + }, + { + "id": 110, + "name": "nextProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 21, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 111, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 112, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 22, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 113, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 23, + "character": 9 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 112, + 113 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 21, + "character": 12 + } + ] + } + } + }, + { + "id": 114, + "name": "prevProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 25, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 115, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 116, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 26, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 117, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 27, + "character": 9 + } + ], + "type": { + "type": "reference", + "name": "CSSProperties" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 116, + 117 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 25, + "character": 12 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 106, + 110, + 114 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 13, + "character": 33 + } + ] + } + } + }, + { + "id": 118, + "name": "NavigationMonths", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The months that is possible to navigate." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 34, + "character": 28 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 119, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 120, + "name": "nextMonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 35, + "character": 11 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 121, + "name": "prevMonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 36, + "character": 11 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 120, + 121 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/types.ts", + "line": 34, + "character": 30 + } + ] + } + } + }, + { + "id": 532, + "name": "UseInputDayPickerProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props to attach to the DayPicker component" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 15, + "character": 34 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 533, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 535, + "name": "onDayClick", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 17, + "character": 12 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "onDayClick" + }, + "objectType": { + "type": "reference", + "name": "DayPickerProps" + } + } + }, + { + "id": 534, + "name": "onMonthChange", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 16, + "character": 15 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "onMonthChange" + }, + "objectType": { + "type": "reference", + "name": "DayPickerProps" + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 535, + 534 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 15, + "character": 36 + } + ] + } + } + }, + { + "id": 536, + "name": "UseInputInputProps", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Props to attach to the `input` HTML element" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 21, + "character": 30 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 537, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 540, + "name": "onBlur", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 24, + "character": 8 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "onBlur" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "input" + }, + "objectType": { + "type": "reference", + "name": "IntrinsicElements" + } + } + } + }, + { + "id": 541, + "name": "onChange", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 25, + "character": 10 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "onChange" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "input" + }, + "objectType": { + "type": "reference", + "name": "IntrinsicElements" + } + } + } + }, + { + "id": 539, + "name": "onFocus", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 23, + "character": 9 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "onFocus" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "input" + }, + "objectType": { + "type": "reference", + "name": "IntrinsicElements" + } + } + } + }, + { + "id": 538, + "name": "value", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 22, + "character": 7 + } + ], + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "value" + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "input" + }, + "objectType": { + "type": "reference", + "name": "IntrinsicElements" + } + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 540, + 541, + 539, + 538 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 21, + "character": 32 + } + ] + } + } + }, + { + "id": 135, + "name": "WeekNumberFormatter", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 13, + "character": 31 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 136, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 137, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 138, + "name": "weekNumber", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 139, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 140, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 141, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 15, + "character": 20 + } + ], + "type": { + "type": "reference", + "name": "DateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 141 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 15, + "character": 11 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/types.ts", + "line": 13, + "character": 33 + } + ] + } + } + }, + { + "id": 17, + "name": "WeekdayNameFormatter", + "kind": 4194304, + "kindString": "Type alias", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Format the weekday name." + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 19, + "character": 32 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 18, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 19, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 20, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 21, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 22, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 23, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 21, + "character": 20 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 23 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 21, + "character": 11 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/types.ts", + "line": 19, + "character": 34 + } + ] + } + } + }, + { + "id": 526, + "name": "Day", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 527, + "name": "Day", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "The `Day` component renders the content of the day cell. It renders a button\nif the day is interactive (i.e. it is clickable).", + "text": "This component can be [[include:swizzling.md]].\n" + }, + "parameters": [ + { + "id": 528, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 71, + "name": "DayProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/Day.tsx", + "line": 15, + "character": 19 + } + ] + }, + { + "id": 450, + "name": "DayPicker", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 451, + "name": "DayPicker", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Render a date picker component.", + "text": "To select a day:\n\n```jsx\nfunction App() {\nreturn (\n \n);\n```" + }, + "parameters": [ + { + "id": 452, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + }, + "defaultValue": "defaultProps" + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/DayPicker.tsx", + "line": 28, + "character": 25 + } + ] + }, + { + "id": 9, + "name": "Head", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 10, + "name": "Head", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Render the head of the month table, including the weekday names (Mon, Tue,\netc.)." + }, + "parameters": [ + { + "id": 11, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 5, + "name": "HeadProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/Head.tsx", + "line": 10, + "character": 20 + } + ] + }, + { + "id": 68, + "name": "MonthCaption", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 69, + "name": "MonthCaption", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Renders the caption of the month." + }, + "parameters": [ + { + "id": 70, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 49, + "name": "MonthCaptionProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/MonthCaption.tsx", + "line": 10, + "character": 28 + } + ] + }, + { + "id": 46, + "name": "MonthTable", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 47, + "name": "MonthTable", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Render the month table." + }, + "parameters": [ + { + "id": 48, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 43, + "name": "MonthTableProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/MonthTable.tsx", + "line": 11, + "character": 26 + } + ] + }, + { + "id": 447, + "name": "Months", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 448, + "name": "Months", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Render the months and the navigation." + }, + "parameters": [ + { + "id": 449, + "name": "initialProps", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + }, + "defaultValue": "defaultProps" + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Months/Months.tsx", + "line": 18, + "character": 22 + } + ] + }, + { + "id": 128, + "name": "Navigation", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 129, + "name": "Navigation", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Renders the buttons to navigate between months." + }, + "parameters": [ + { + "id": 130, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 102, + "name": "NavigationProps" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Element" + }, + { + "type": "intrinsic", + "name": "null" + } + ] + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/Navigation.tsx", + "line": 11, + "character": 26 + } + ] + }, + { + "id": 142, + "name": "WeekNumber", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 143, + "name": "WeekNumber", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Render the number of the week when [[showWeekNumber]] is enabled." + }, + "parameters": [ + { + "id": 144, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 131, + "name": "WeekNumberProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekNumber/WeekNumber.tsx", + "line": 9, + "character": 26 + } + ] + }, + { + "id": 24, + "name": "WeekRow", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 25, + "name": "WeekRow", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": { + "shortText": "Render a week row." + }, + "parameters": [ + { + "id": 26, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 12, + "name": "WeekRowProps" + } + } + ], + "type": { + "type": "reference", + "name": "Element" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/WeekRow/WeekRow.tsx", + "line": 11, + "character": 23 + } + ] + }, + { + "id": 311, + "name": "defaultFormatCaption", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 312, + "name": "defaultFormatCaption", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": { + "shortText": "The default function used to format the caption. Use the [[formatCaption]]\nprop to use another function.", + "returns": "The month using the `\"LLLL Y:` [format\nstring](https://date-fns.org/docs/format)." + }, + "parameters": [ + { + "id": 313, + "name": "month", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 314, + "name": "formatOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 315, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 316, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatCaption.ts", + "line": 13, + "character": 26 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 316 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatCaption.ts", + "line": 13, + "character": 17 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatCaption.ts", + "line": 11, + "character": 36 + } + ] + }, + { + "id": 317, + "name": "defaultFormatDay", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 318, + "name": "defaultFormatDay", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": { + "shortText": "The default function used to format the day date. Use the [[formatDay]] prop\nto use another function.", + "returns": "The day formatted the `\"d\"` [format\nstring](https://date-fns.org/docs/format)." + }, + "parameters": [ + { + "id": 319, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 320, + "name": "formatOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 321, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 322, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatDay.ts", + "line": 13, + "character": 26 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 322 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatDay.ts", + "line": 13, + "character": 17 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatDay.ts", + "line": 11, + "character": 32 + } + ] + }, + { + "id": 323, + "name": "defaultFormatWeekNumber", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 324, + "name": "defaultFormatWeekNumber", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": { + "shortText": "The default function used to format the week number. Use the\n[[formatWeekNumber]] prop to use another function.", + "returns": "The weeknumber formatted as string." + }, + "parameters": [ + { + "id": 325, + "name": "weekNumber", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatWeekNumber.ts", + "line": 8, + "character": 39 + } + ] + }, + { + "id": 326, + "name": "defaultFormatWeekdayName", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 327, + "name": "defaultFormatWeekdayName", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": { + "shortText": "The default function used to format the day. Use the [[formatWeekdayName]]\nprop to use another function.", + "returns": "The day formatted the `\"E\"` [format\nstring](https://date-fns.org/docs/format)." + }, + "parameters": [ + { + "id": 328, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 329, + "name": "formatOptions", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 330, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 331, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatWeekdayName.ts", + "line": 12, + "character": 26 + } + ], + "type": { + "type": "reference", + "name": "dateFns.Locale" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 331 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatWeekdayName.ts", + "line": 12, + "character": 17 + } + ] + } + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultFormatWeekdayName.ts", + "line": 10, + "character": 40 + } + ] + }, + { + "id": 277, + "name": "filterUndefinedProps", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 278, + "name": "filterUndefinedProps", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Filter the undefined props of `obj`." + }, + "parameters": [ + { + "id": 279, + "name": "obj", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 280, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "indexSignature": [ + { + "id": 281, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 282, + "name": "index", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Months/filterUndefinedProps.ts", + "line": 4, + "character": 41 + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 283, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "indexSignature": [ + { + "id": 284, + "name": "__index", + "kind": 8192, + "kindString": "Index signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 285, + "name": "index", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Months/filterUndefinedProps.ts", + "line": 7, + "character": 3 + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Months/filterUndefinedProps.ts", + "line": 4, + "character": 36 + } + ] + }, + { + "id": 65, + "name": "getCaptionProps", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 66, + "name": "getCaptionProps", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return props for creating a [[MonthCaption]] component.", + "text": "#### Usage\n\nUse this helper when swizzling the caption using the\n[[DayPickerProps.components]] prop.\n\n```jsx\nfunction MonthCaption({ dayPickerProps }): JSX.Element {\n const { containerProps } = getCaptionProps(dayPickerProps);\n return (\n \n Something inside the caption\n ;\n )\n}\n\n```\n" + }, + "parameters": [ + { + "id": 67, + "name": "dayPickerProps", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 52, + "name": "CaptionHtmlProps" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthCaption/getCaptionProps.ts", + "line": 24, + "character": 31 + } + ] + }, + { + "id": 461, + "name": "getDayProps", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 462, + "name": "getDayProps", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return props for creating a [[Day]] component." + }, + "parameters": [ + { + "id": 463, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 464, + "name": "modifiers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 165, + "name": "MatchingModifiers" + } + }, + { + "id": 465, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 97, + "name": "DayHtmlProps" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Day/getDayProps.ts", + "line": 12, + "character": 27 + } + ] + }, + { + "id": 510, + "name": "getMatchingModifiers", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 511, + "name": "getMatchingModifiers", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Given a date and a list of modifiers, return the names of the modifiers matching that day." + }, + "parameters": [ + { + "id": 512, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 513, + "name": "modifiers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 160, + "name": "DaysModifiers" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/getMatchingModifiers.ts", + "line": 18, + "character": 36 + } + ] + }, + { + "id": 514, + "name": "getModifiersFromProps", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 515, + "name": "getModifiersFromProps", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the `modifiers` prop including the modifiers from shortcut-props\n(`selected`, `disabled` and `hidden`)" + }, + "parameters": [ + { + "id": 516, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 160, + "name": "DaysModifiers" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/getModifiersFromProps.ts", + "line": 7, + "character": 37 + } + ] + }, + { + "id": 274, + "name": "getMonths", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 275, + "name": "getMonths", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Get the months to render in DayPicker according to the passed\n`numberOfMonths` and other month-related props." + }, + "parameters": [ + { + "id": 276, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Months/getMonths.ts", + "line": 8, + "character": 25 + } + ] + }, + { + "id": 122, + "name": "getNavigation", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 123, + "name": "getNavigation", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the next and the previous months for the navigation component,\naccording to the DayPicker props." + }, + "parameters": [ + { + "id": 124, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 118, + "name": "NavigationMonths" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/getNavigation.ts", + "line": 10, + "character": 29 + } + ] + }, + { + "id": 125, + "name": "getNavigationProps", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 126, + "name": "getNavigationProps", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the props for the Navigation component and its children." + }, + "parameters": [ + { + "id": 127, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 104, + "name": "NavigationHtmlProps" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Navigation/getNavigationProps.ts", + "line": 9, + "character": 34 + } + ] + }, + { + "id": 31, + "name": "getOutsideEndDays", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 32, + "name": "getOutsideEndDays", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the outside ending days for the given day." + }, + "parameters": [ + { + "id": 33, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 34, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/getOutsideEndDays.ts", + "line": 7, + "character": 33 + } + ] + }, + { + "id": 517, + "name": "getOutsideModifier", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 518, + "name": "getOutsideModifier", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the modifier for days outside the current month." + }, + "parameters": [ + { + "id": 519, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 520, + "name": "currentMonth", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "id": 153, + "name": "DayModifier" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/getOutsideModifier.ts", + "line": 7, + "character": 34 + } + ] + }, + { + "id": 27, + "name": "getOutsideStartDays", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 28, + "name": "getOutsideStartDays", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the outside starting days for the given day." + }, + "parameters": [ + { + "id": 29, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 30, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "name": "Date" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/getOutsideStartDays.ts", + "line": 7, + "character": 35 + } + ] + }, + { + "id": 1, + "name": "getWeekdaysNames", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 2, + "name": "getWeekdaysNames", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the name of the weekdays according to the formatting function." + }, + "parameters": [ + { + "id": 3, + "name": "locale", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "DateFns.Locale" + } + }, + { + "id": 4, + "name": "format", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "stringLiteral", + "value": "formatCaption" + }, + "objectType": { + "type": "reference", + "name": "DayPickerProps" + } + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/Head/getWeekdaysNames.ts", + "line": 7, + "character": 32 + } + ] + }, + { + "id": 39, + "name": "getWeeks", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 40, + "name": "getWeeks", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return the weeks belonging to the given month." + }, + "parameters": [ + { + "id": 41, + "name": "month", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 42, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 35, + "name": "MonthWeeks" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/MonthTable/getWeeks.ts", + "line": 24, + "character": 24 + } + ] + }, + { + "id": 466, + "name": "isDayAfter", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 467, + "name": "isDayAfter", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return true if `day1` is after `day2`." + }, + "parameters": [ + { + "id": 468, + "name": "day1", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 469, + "name": "day2", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 13, + "character": 19 + } + ] + }, + { + "id": 470, + "name": "isDayBefore", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 471, + "name": "isDayBefore", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return true if `day1` is before `day2`." + }, + "parameters": [ + { + "id": 472, + "name": "day1", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 473, + "name": "day2", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 20, + "character": 20 + } + ] + }, + { + "id": 529, + "name": "isValidDate", + "kind": 64, + "kindString": "Function", + "flags": { + "isPrivate": true, + "isExported": true + }, + "signatures": [ + { + "id": 530, + "name": "isValidDate", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isPrivate": true, + "isExported": true + }, + "comment": {}, + "parameters": [ + { + "id": 531, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 10, + "character": 20 + } + ] + }, + { + "id": 474, + "name": "matchDate", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 475, + "name": "matchDate", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return true if `day` matches the given [[DayMatcher]]." + }, + "parameters": [ + { + "id": 476, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 477, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 27, + "character": 18 + } + ] + }, + { + "id": 502, + "name": "matchDay", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 503, + "name": "matchDay", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Return `true` if a day matches a day matcher." + }, + "parameters": [ + { + "id": 504, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 505, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 95, + "character": 24 + } + ] + }, + { + "id": 486, + "name": "matchDayAfter", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 487, + "name": "matchDayAfter", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "TODO: write docs" + }, + "parameters": [ + { + "id": 488, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 489, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 57, + "character": 22 + } + ] + }, + { + "id": 482, + "name": "matchDayBefore", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 483, + "name": "matchDayBefore", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "TODO: write docs" + }, + "parameters": [ + { + "id": 484, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 485, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 48, + "character": 23 + } + ] + }, + { + "id": 490, + "name": "matchDayBetween", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 491, + "name": "matchDayBetween", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "TODO: write docs" + }, + "parameters": [ + { + "id": 492, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 493, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 66, + "character": 24 + } + ] + }, + { + "id": 478, + "name": "matchDayInRange", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 479, + "name": "matchDayInRange", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Returns true if the day is in the range specified by the [[DayMatcher]]." + }, + "parameters": [ + { + "id": 480, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 481, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 35, + "character": 24 + } + ] + }, + { + "id": 494, + "name": "matchDayOfWeek", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 495, + "name": "matchDayOfWeek", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "TODO: write docs" + }, + "parameters": [ + { + "id": 496, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 497, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 79, + "character": 23 + } + ] + }, + { + "id": 498, + "name": "matchFunction", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 499, + "name": "matchFunction", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "TODO: write docs" + }, + "parameters": [ + { + "id": 500, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 501, + "name": "matcher", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 189, + "name": "DayMatcher" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/matchModifier.ts", + "line": 87, + "character": 22 + } + ] + }, + { + "id": 506, + "name": "reduceCallback", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true, + "isConst": true + }, + "signatures": [ + { + "id": 507, + "name": "reduceCallback", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 508, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 509, + "name": "modifiers", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 160, + "name": "DaysModifiers" + } + } + ], + "type": { + "type": "reference", + "name": "(Anonymous function)" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/modifiers-utils/getMatchingModifiers.ts", + "line": 4, + "character": 20 + } + ] + }, + { + "id": 542, + "name": "useInput", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 543, + "name": "useInput", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Hook to bind a input with a calendar.", + "text": "```jsx\nconst {\n month,\n selected,\n dayPickerProps,\n inputProps\n} = useInput(new Date());\n\n\n\n```\n" + }, + "parameters": [ + { + "id": 544, + "name": "initialSelectedDay", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Date" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + }, + { + "id": 545, + "name": "formatStr", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 546, + "name": "options", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 547, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 548, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 49, + "character": 10 + } + ], + "type": { + "type": "reference", + "name": "DateFns.Locale" + } + }, + { + "id": 549, + "name": "required", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 50, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 548, + 549 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 48, + "character": 10 + } + ] + } + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 550, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 553, + "name": "dayPickerProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 55, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 532, + "name": "UseInputDayPickerProps" + } + }, + { + "id": 554, + "name": "inputProps", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 56, + "character": 12 + } + ], + "type": { + "type": "reference", + "id": 536, + "name": "UseInputInputProps" + } + }, + { + "id": 551, + "name": "month", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 53, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 552, + "name": "selected", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 54, + "character": 10 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "name": "Date" + }, + { + "type": "intrinsic", + "name": "undefined" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 553, + 554, + 551, + 552 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 52, + "character": 2 + } + ] + } + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useInput.ts", + "line": 45, + "character": 24 + } + ] + }, + { + "id": 521, + "name": "useModifiers", + "kind": 64, + "kindString": "Function", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 522, + "name": "useModifiers", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Get the modifiers for the specified day." + }, + "parameters": [ + { + "id": 523, + "name": "day", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 524, + "name": "currentMonth", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "name": "Date" + } + }, + { + "id": 525, + "name": "props", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true + }, + "type": { + "type": "reference", + "id": 215, + "name": "DayPickerProps" + } + } + ], + "type": { + "type": "reference", + "id": 165, + "name": "MatchingModifiers" + } + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/hooks/useModifiers.ts", + "line": 15, + "character": 28 + } + ] + }, + { + "id": 286, + "name": "defaultClassNames", + "kind": 2097152, + "kindString": "Object literal", + "flags": { + "isExported": true, + "isConst": true + }, + "comment": { + "shortText": "List the default CSS class names. Class names can be overridden using the\n[[classNames]] prop." + }, + "children": [ + { + "id": 309, + "name": "aftermonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 45, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_outside\"" + }, + { + "id": 310, + "name": "beforemonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 46, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_outside\"" + }, + { + "id": 288, + "name": "caption", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 10, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-caption\"" + }, + { + "id": 289, + "name": "day", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 13, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day\"" + }, + { + "id": 290, + "name": "dayWrapper", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 14, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_wrapper\"" + }, + { + "id": 307, + "name": "disabled", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 43, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_disabled\"" + }, + { + "id": 295, + "name": "head", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 23, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-head\"" + }, + { + "id": 296, + "name": "headRow", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 24, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-head_row\"" + }, + { + "id": 298, + "name": "headWeekName", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 26, + "character": 14 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-head_weekname\"" + }, + { + "id": 297, + "name": "headWeekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 25, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-head_weeknumber\"" + }, + { + "id": 291, + "name": "month", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 17, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-month\"" + }, + { + "id": 292, + "name": "monthTable", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 18, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-month_table\"" + }, + { + "id": 293, + "name": "monthTbody", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 19, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-month_tbody\"" + }, + { + "id": 294, + "name": "months", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 20, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-months\"" + }, + { + "id": 299, + "name": "nav", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 29, + "character": 5 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-nav\"" + }, + { + "id": 301, + "name": "navNext", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 31, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-nav_next\"" + }, + { + "id": 300, + "name": "navPrev", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 30, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-nav_prev\"" + }, + { + "id": 287, + "name": "root", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "comment": { + "shortText": "Root element" + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 9, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp\"" + }, + { + "id": 306, + "name": "selected", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 42, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_selected\"" + }, + { + "id": 308, + "name": "today", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 44, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-day_today\"" + }, + { + "id": 302, + "name": "week", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 34, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-week\"" + }, + { + "id": 303, + "name": "weekDay", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 35, + "character": 9 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-week_day\"" + }, + { + "id": 305, + "name": "weekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 39, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-weeknumber\"" + }, + { + "id": 304, + "name": "weekWeeknumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 36, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"rdp-week_weeknumber\"" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 309, + 310, + 288, + 289, + 290, + 307, + 295, + 296, + 298, + 297, + 291, + 292, + 293, + 294, + 299, + 301, + 300, + 287, + 306, + 308, + 302, + 303, + 305, + 304 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultClassNames.ts", + "line": 7, + "character": 30 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 453, + "name": "defaultModifiers", + "kind": 2097152, + "kindString": "Object literal", + "flags": { + "isExported": true, + "isConst": true + }, + "comment": { + "shortText": "Default modifiers." + }, + "children": [ + { + "id": 457, + "name": "aftermonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 10, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 458, + "name": "beforemonth", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 11, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 454, + "name": "disabled", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 7, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 455, + "name": "hidden", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 8, + "character": 8 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 456, + "name": "interactive", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 9, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "true" + }, + "defaultValue": "true" + }, + { + "id": 459, + "name": "selected", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 12, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 460, + "name": "today", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 13, + "character": 7 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 457, + 458, + 454, + 455, + 456, + 459, + 460 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultModifiers.ts", + "line": 6, + "character": 29 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 332, + "name": "defaultProps", + "kind": 2097152, + "kindString": "Object literal", + "flags": { + "isExported": true, + "isConst": true + }, + "comment": { + "shortText": "List the default props used by the [[DayPicker]] component." + }, + "children": [ + { + "id": 336, + "name": "className", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 23, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"\"" + }, + { + "id": 334, + "name": "classNames", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 22, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 335, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + }, + "defaultValue": "defaultClassNames" + }, + { + "id": 433, + "name": "daysClassNames", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 39, + "character": 16 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 434, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + }, + { + "id": 435, + "name": "daysStyles", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 40, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 436, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + }, + { + "id": 333, + "name": "enableOutsideDaysClick", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 21, + "character": 24 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 346, + "name": "fixedWeeks", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 32, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 347, + "name": "formatCaption", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 33, + "character": 15 + } + ], + "type": { + "type": "reference", + "id": 311, + "name": "defaultFormatCaption" + }, + "defaultValue": "defaultFormatCaption" + }, + { + "id": 348, + "name": "formatDay", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 34, + "character": 11 + } + ], + "type": { + "type": "reference", + "id": 317, + "name": "defaultFormatDay" + }, + "defaultValue": "defaultFormatDay" + }, + { + "id": 350, + "name": "formatWeekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 36, + "character": 18 + } + ], + "type": { + "type": "reference", + "id": 323, + "name": "defaultFormatWeekNumber" + }, + "defaultValue": "defaultFormatWeekNumber" + }, + { + "id": 349, + "name": "formatWeekdayName", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 35, + "character": 19 + } + ], + "type": { + "type": "reference", + "id": 326, + "name": "defaultFormatWeekdayName" + }, + "defaultValue": "defaultFormatWeekdayName" + }, + { + "id": 351, + "name": "locale", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 37, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 352, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 353, + "name": "code", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 36, + "character": 6 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 354, + "name": "formatDistance", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 37, + "character": 16 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 355, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 356, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 357, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 37, + "character": 18 + } + ] + } + } + }, + { + "id": 388, + "name": "formatLong", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 47, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 389, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 390, + "name": "date", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 48, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 391, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 392, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 393, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 48, + "character": 9 + } + ] + } + } + }, + { + "id": 398, + "name": "dateTime", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 50, + "character": 12 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 399, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 400, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 401, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 50, + "character": 13 + } + ] + } + } + }, + { + "id": 394, + "name": "time", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 49, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 395, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 396, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 397, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 49, + "character": 9 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 390, + 398, + 394 + ] + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 47, + "character": 14 + } + ] + } + } + }, + { + "id": 358, + "name": "formatRelative", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 38, + "character": 16 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 359, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 360, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 361, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 38, + "character": 18 + } + ] + } + } + }, + { + "id": 362, + "name": "localize", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 39, + "character": 10 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 363, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 380, + "name": "day", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 44, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 381, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 382, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 383, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 44, + "character": 8 + } + ] + } + } + }, + { + "id": 384, + "name": "dayPeriod", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 45, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 385, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 386, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 387, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 45, + "character": 14 + } + ] + } + } + }, + { + "id": 368, + "name": "era", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 41, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 369, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 370, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 371, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 41, + "character": 8 + } + ] + } + } + }, + { + "id": 376, + "name": "month", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 43, + "character": 9 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 377, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 378, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 379, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 43, + "character": 10 + } + ] + } + } + }, + { + "id": 364, + "name": "ordinalNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 40, + "character": 17 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 365, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 366, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 367, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 40, + "character": 18 + } + ] + } + } + }, + { + "id": 372, + "name": "quarter", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 42, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 373, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 374, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 375, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 42, + "character": 12 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 380, + 384, + 368, + 376, + 364, + 372 + ] + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 39, + "character": 12 + } + ] + } + } + }, + { + "id": 402, + "name": "match", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 52, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 403, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 420, + "name": "day", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 57, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 421, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 422, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 423, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 57, + "character": 8 + } + ] + } + } + }, + { + "id": 424, + "name": "dayPeriod", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 58, + "character": 13 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 425, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 426, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 427, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 58, + "character": 14 + } + ] + } + } + }, + { + "id": 408, + "name": "era", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 54, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 409, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 410, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 411, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 54, + "character": 8 + } + ] + } + } + }, + { + "id": 416, + "name": "month", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 56, + "character": 9 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 417, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 418, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 419, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 56, + "character": 10 + } + ] + } + } + }, + { + "id": 404, + "name": "ordinalNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 53, + "character": 17 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 405, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 406, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 407, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 53, + "character": 18 + } + ] + } + } + }, + { + "id": 412, + "name": "quarter", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 55, + "character": 11 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 413, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "signatures": [ + { + "id": 414, + "name": "__call", + "kind": 4096, + "kindString": "Call signature", + "flags": { + "isExported": true + }, + "parameters": [ + { + "id": 415, + "name": "args", + "kind": 32768, + "kindString": "Parameter", + "flags": { + "isExported": true, + "isRest": true + }, + "type": { + "type": "reference", + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Array" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 55, + "character": 12 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 420, + 424, + 408, + 416, + 404, + 412 + ] + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 52, + "character": 9 + } + ] + } + } + }, + { + "id": 428, + "name": "options", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 60, + "character": 9 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 429, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 431, + "name": "firstWeekContainsDate", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 62, + "character": 25 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "unknown", + "name": "1" + }, + { + "type": "unknown", + "name": "2" + }, + { + "type": "unknown", + "name": "3" + }, + { + "type": "unknown", + "name": "4" + }, + { + "type": "unknown", + "name": "5" + }, + { + "type": "unknown", + "name": "6" + }, + { + "type": "unknown", + "name": "7" + } + ] + } + }, + { + "id": 430, + "name": "weekStartsOn", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true, + "isOptional": true + }, + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 61, + "character": 16 + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "unknown", + "name": "0" + }, + { + "type": "unknown", + "name": "1" + }, + { + "type": "unknown", + "name": "2" + }, + { + "type": "unknown", + "name": "3" + }, + { + "type": "unknown", + "name": "4" + }, + { + "type": "unknown", + "name": "5" + }, + { + "type": "unknown", + "name": "6" + } + ] + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 431, + 430 + ] + } + ], + "sources": [ + { + "fileName": "node_modules/date-fns/typings.d.ts", + "line": 60, + "character": 11 + } + ] + } + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 353, + 354, + 388, + 358, + 362, + 402, + 428 + ] + } + ] + } + }, + "defaultValue": "english" + }, + { + "id": 437, + "name": "month", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 41, + "character": 7 + } + ], + "type": { + "type": "reference", + "name": "Date" + }, + "defaultValue": "startOfMonth(new Date())" + }, + { + "id": 432, + "name": "nextLabel", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 38, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"▶\"" + }, + { + "id": 438, + "name": "numberOfMonths", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 42, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "1" + }, + { + "id": 439, + "name": "pagedNavigation", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 43, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 440, + "name": "prevLabel", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 44, + "character": 11 + } + ], + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"◀\"" + }, + { + "id": 441, + "name": "reverseMonths", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 45, + "character": 15 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 442, + "name": "showCaption", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 46, + "character": 13 + } + ], + "type": { + "type": "intrinsic", + "name": "true" + }, + "defaultValue": "true" + }, + { + "id": 443, + "name": "showHead", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 47, + "character": 10 + } + ], + "type": { + "type": "intrinsic", + "name": "true" + }, + "defaultValue": "true" + }, + { + "id": 444, + "name": "showNavigation", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 48, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "true" + }, + "defaultValue": "true" + }, + { + "id": 445, + "name": "showOutsideDays", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 49, + "character": 17 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 446, + "name": "showWeekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 50, + "character": 16 + } + ], + "type": { + "type": "intrinsic", + "name": "false" + }, + "defaultValue": "false" + }, + { + "id": 337, + "name": "style", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 24, + "character": 7 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 338, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + }, + { + "id": 339, + "name": "styles", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 25, + "character": 8 + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 340, + "name": "__type", + "kind": 65536, + "kindString": "Type literal", + "flags": { + "isExported": true + } + } + } + }, + { + "id": 341, + "name": "components", + "kind": 2097152, + "kindString": "Object literal", + "flags": { + "isExported": true + }, + "children": [ + { + "id": 343, + "name": "Day", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 28, + "character": 7 + } + ], + "type": { + "type": "reference", + "id": 526, + "name": "Day" + } + }, + { + "id": 342, + "name": "MonthCaption", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 27, + "character": 16 + } + ], + "type": { + "type": "reference", + "id": 68, + "name": "MonthCaption" + } + }, + { + "id": 344, + "name": "Navigation", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 29, + "character": 14 + } + ], + "type": { + "type": "reference", + "id": 128, + "name": "Navigation" + } + }, + { + "id": 345, + "name": "WeekNumber", + "kind": 32, + "kindString": "Variable", + "flags": { + "isExported": true + }, + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 30, + "character": 14 + } + ], + "type": { + "type": "reference", + "id": 142, + "name": "WeekNumber" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 343, + 342, + 344, + 345 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 26, + "character": 12 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Variables", + "kind": 32, + "children": [ + 336, + 334, + 433, + 435, + 333, + 346, + 347, + 348, + 350, + 349, + 351, + 437, + 432, + 438, + 439, + 440, + 441, + 442, + 443, + 444, + 445, + 446, + 337, + 339 + ] + }, + { + "title": "Object literals", + "kind": 2097152, + "children": [ + 341 + ] + } + ], + "sources": [ + { + "fileName": "packages/react-day-picker/src/components/DayPicker/defaults/defaultProps.ts", + "line": 20, + "character": 25 + } + ], + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Enumerations", + "kind": 4, + "children": [ + 190, + 145 + ] + }, + { + "title": "Interfaces", + "kind": 256, + "children": [ + 215, + 71, + 5, + 49, + 43, + 102, + 131, + 12 + ] + }, + { + "title": "Type aliases", + "kind": 4194304, + "children": [ + 52, + 268, + 257, + 82, + 75, + 97, + 164, + 189, + 153, + 253, + 255, + 93, + 154, + 160, + 158, + 167, + 175, + 172, + 178, + 168, + 182, + 185, + 165, + 58, + 263, + 35, + 104, + 118, + 532, + 536, + 135, + 17 + ] + }, + { + "title": "Functions", + "kind": 64, + "children": [ + 526, + 450, + 9, + 68, + 46, + 447, + 128, + 142, + 24, + 311, + 317, + 323, + 326, + 277, + 65, + 461, + 510, + 514, + 274, + 122, + 125, + 31, + 517, + 27, + 1, + 39, + 466, + 470, + 529, + 474, + 502, + 486, + 482, + 490, + 478, + 494, + 498, + 506, + 542, + 521 + ], + "categories": [ + { + "title": "Components", + "children": [ + 526, + 450, + 9, + 68, + 46, + 447, + 128, + 142, + 24 + ] + }, + { + "title": "Hooks", + "children": [ + 542, + 521 + ] + }, + { + "title": "Other", + "children": [ + 311, + 317, + 323, + 326, + 277, + 65, + 461, + 510, + 514, + 274, + 122, + 125, + 31, + 517, + 27, + 1, + 39, + 466, + 470, + 529, + 474, + 502, + 486, + 482, + 490, + 478, + 494, + 498, + 506 + ] + } + ] + }, + { + "title": "Object literals", + "kind": 2097152, + "children": [ + 286, + 453, + 332 + ] + } + ] +} \ No newline at end of file diff --git a/website/docs/api/defaultFormatCaption.mdx b/website/docs/api/defaultFormatCaption.mdx new file mode 100644 index 0000000000..b8fec67cbf --- /dev/null +++ b/website/docs/api/defaultFormatCaption.mdx @@ -0,0 +1,16 @@ +--- +id: defaultformatcaption +title: defaultFormatCaption +sidebar_label: defaultFormatCaption +--- + + +The default function used to format the caption. Use the [formatCaption](#formatcaption) +prop to use another function. + + + + + +# defaultFormatCaption props + diff --git a/website/docs/api/defaultFormatDay.mdx b/website/docs/api/defaultFormatDay.mdx new file mode 100644 index 0000000000..feb9d05513 --- /dev/null +++ b/website/docs/api/defaultFormatDay.mdx @@ -0,0 +1,16 @@ +--- +id: defaultformatday +title: defaultFormatDay +sidebar_label: defaultFormatDay +--- + + +The default function used to format the day date. Use the [formatDay](#formatday) prop +to use another function. + + + + + +# defaultFormatDay props + diff --git a/website/docs/api/defaultFormatWeekNumber.mdx b/website/docs/api/defaultFormatWeekNumber.mdx new file mode 100644 index 0000000000..195decdd8f --- /dev/null +++ b/website/docs/api/defaultFormatWeekNumber.mdx @@ -0,0 +1,16 @@ +--- +id: defaultformatweeknumber +title: defaultFormatWeekNumber +sidebar_label: defaultFormatWeekNumber +--- + + +The default function used to format the week number. Use the +[formatWeekNumber](#formatweeknumber) prop to use another function. + + + + + +# defaultFormatWeekNumber props + diff --git a/website/docs/api/defaultFormatWeekdayName.mdx b/website/docs/api/defaultFormatWeekdayName.mdx new file mode 100644 index 0000000000..01240583d4 --- /dev/null +++ b/website/docs/api/defaultFormatWeekdayName.mdx @@ -0,0 +1,16 @@ +--- +id: defaultformatweekdayname +title: defaultFormatWeekdayName +sidebar_label: defaultFormatWeekdayName +--- + + +The default function used to format the day. Use the [formatWeekdayName](#formatweekdayname) +prop to use another function. + + + + + +# defaultFormatWeekdayName props + diff --git a/website/docs/api/enumerations.mdx b/website/docs/api/enumerations.mdx new file mode 100644 index 0000000000..f402781c56 --- /dev/null +++ b/website/docs/api/enumerations.mdx @@ -0,0 +1,56 @@ +--- +id: enumerations +title: Enumerations +sidebar_label: Enumerations +--- + + + +## DayPickerElements + +List of the name of the DOM elements interface elements. + + +|Name|Description +|----|----------- +| "caption"|| +| "day"|| +| "dayWrapper"|| +| "disabled"|| +| "head"|| +| "headRow"|| +| "headWeekName"|| +| "headWeekNumber"|| +| "month"|| +| "months"|| +| "monthTable"|| +| "monthTbody"|| +| "nav"|Container of [Navigation](#navigation).| +| "navNext"|"Next Month" button in [Navigation](#navigation).| +| "navPrev"|"Previous Month" button in [Navigation](#navigation).| +| "aftermonth"|| +| "beforemonth"|| +| "root"|| +| "selected"|| +| "today"|| +| "week"|| +| "weekDay"|| +| "weekNumber"|The weeknumber| +| "weekWeeknumber"|| + + +## DefaultModifiersNames + +List the names of the default modifiers. + + +|Name|Description +|----|----------- +| "aftermonth"|The day is outside.| +| "beforemonth"|The day is outside.| +| "disabled"|The day is disabled.| +| "hidden"|The day is hidden.| +| "interactive"|The day is interactive.| +| "selected"|The day is selected.| +| "today"|The day is today.| + diff --git a/website/docs/api/filterUndefinedProps.mdx b/website/docs/api/filterUndefinedProps.mdx new file mode 100644 index 0000000000..113d96db40 --- /dev/null +++ b/website/docs/api/filterUndefinedProps.mdx @@ -0,0 +1,15 @@ +--- +id: filterundefinedprops +title: filterUndefinedProps +sidebar_label: filterUndefinedProps +--- + + +Filter the undefined props of `obj`. + + + + + +# filterUndefinedProps props + diff --git a/website/docs/api/getCaptionProps.mdx b/website/docs/api/getCaptionProps.mdx new file mode 100644 index 0000000000..7aafe5a70e --- /dev/null +++ b/website/docs/api/getCaptionProps.mdx @@ -0,0 +1,515 @@ +--- +id: getcaptionprops +title: getCaptionProps +sidebar_label: getCaptionProps +--- + + +Return props for creating a [MonthCaption](#monthcaption) component. + +#### Usage + +Use this helper when swizzling the caption using the +[[DayPickerProps.components]] prop. + +```jsx +function MonthCaption({ dayPickerProps }): JSX.Element { + const { containerProps } = getCaptionProps(dayPickerProps); + return ( + + Something inside the caption + ; + ) +} + +``` + + + + +# getCaptionProps props + + +## className + +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames + +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./undefineds#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components + +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./undefineds#customcomponents) + +
+ + + + +## days + +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./undefineds#daysmodifiers) + +
+ + + + +## daysClassNames + +Change the class names used for the [days modifiers](#days). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./undefineds#daysclassnames) + +
+ + + + +## daysStyles + +Change the inline style for the [days modifiers](#days). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./undefineds#daysstyles) + +
+ + + + +## dir + +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled + +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## enableOutsideDaysClick + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks + +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption + +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./undefineds#monthcaptionformatter) + +
+ + + + +## formatDay + +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./undefineds#dayformatter) + +
+ + + + +## formatWeekNumber + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./undefineds#weeknumberformatter) + +
+ + + + +## formatWeekdayName + +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./undefineds#weekdaynameformatter) + +
+ + + + +## fromMonth + +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden + +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## initialMonth + +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale + +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel + +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths + +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick + +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./undefineds#dayclickeventhandler) + +
+ + + + +## onMonthChange + +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onNextClick + +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onPrevClick + +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## pagedNavigation + +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel + +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected + +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## showCaption + +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead + +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays + +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber + +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style + +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./undefineds#daypickerstyles) + +
+ + + + +## toMonth + +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
diff --git a/website/docs/api/getDayProps.mdx b/website/docs/api/getDayProps.mdx new file mode 100644 index 0000000000..7f83c9d954 --- /dev/null +++ b/website/docs/api/getDayProps.mdx @@ -0,0 +1,15 @@ +--- +id: getdayprops +title: getDayProps +sidebar_label: getDayProps +--- + + +Return props for creating a [Day](#day) component. + + + + + +# getDayProps props + diff --git a/website/docs/api/getMatchingModifiers.mdx b/website/docs/api/getMatchingModifiers.mdx new file mode 100644 index 0000000000..b28b9dcf53 --- /dev/null +++ b/website/docs/api/getMatchingModifiers.mdx @@ -0,0 +1,15 @@ +--- +id: getmatchingmodifiers +title: getMatchingModifiers +sidebar_label: getMatchingModifiers +--- + + +Given a date and a list of modifiers, return the names of the modifiers matching that day. + + + + + +# getMatchingModifiers props + diff --git a/website/docs/api/getModifiersFromProps.mdx b/website/docs/api/getModifiersFromProps.mdx new file mode 100644 index 0000000000..460646fdc9 --- /dev/null +++ b/website/docs/api/getModifiersFromProps.mdx @@ -0,0 +1,500 @@ +--- +id: getmodifiersfromprops +title: getModifiersFromProps +sidebar_label: getModifiersFromProps +--- + + +Return the `modifiers` prop including the modifiers from shortcut-props +(`selected`, `disabled` and `hidden`) + + + + + +# getModifiersFromProps props + + +## className + +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames + +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./undefineds#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components + +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./undefineds#customcomponents) + +
+ + + + +## days + +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./undefineds#daysmodifiers) + +
+ + + + +## daysClassNames + +Change the class names used for the [days modifiers](#days). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./undefineds#daysclassnames) + +
+ + + + +## daysStyles + +Change the inline style for the [days modifiers](#days). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./undefineds#daysstyles) + +
+ + + + +## dir + +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled + +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## enableOutsideDaysClick + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks + +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption + +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./undefineds#monthcaptionformatter) + +
+ + + + +## formatDay + +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./undefineds#dayformatter) + +
+ + + + +## formatWeekNumber + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./undefineds#weeknumberformatter) + +
+ + + + +## formatWeekdayName + +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./undefineds#weekdaynameformatter) + +
+ + + + +## fromMonth + +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden + +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## initialMonth + +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale + +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel + +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths + +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick + +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./undefineds#dayclickeventhandler) + +
+ + + + +## onMonthChange + +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onNextClick + +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onPrevClick + +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## pagedNavigation + +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel + +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected + +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## showCaption + +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead + +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays + +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber + +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style + +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./undefineds#daypickerstyles) + +
+ + + + +## toMonth + +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
diff --git a/website/docs/api/getMonths.mdx b/website/docs/api/getMonths.mdx new file mode 100644 index 0000000000..67ada878cf --- /dev/null +++ b/website/docs/api/getMonths.mdx @@ -0,0 +1,500 @@ +--- +id: getmonths +title: getMonths +sidebar_label: getMonths +--- + + +Get the months to render in DayPicker according to the passed +`numberOfMonths` and other month-related props. + + + + + +# getMonths props + + +## className + +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames + +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./undefineds#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components + +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./undefineds#customcomponents) + +
+ + + + +## days + +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./undefineds#daysmodifiers) + +
+ + + + +## daysClassNames + +Change the class names used for the [days modifiers](#days). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./undefineds#daysclassnames) + +
+ + + + +## daysStyles + +Change the inline style for the [days modifiers](#days). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./undefineds#daysstyles) + +
+ + + + +## dir + +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled + +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## enableOutsideDaysClick + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks + +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption + +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./undefineds#monthcaptionformatter) + +
+ + + + +## formatDay + +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./undefineds#dayformatter) + +
+ + + + +## formatWeekNumber + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./undefineds#weeknumberformatter) + +
+ + + + +## formatWeekdayName + +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./undefineds#weekdaynameformatter) + +
+ + + + +## fromMonth + +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden + +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## initialMonth + +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale + +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel + +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths + +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick + +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./undefineds#dayclickeventhandler) + +
+ + + + +## onMonthChange + +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onNextClick + +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onPrevClick + +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## pagedNavigation + +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel + +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected + +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## showCaption + +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead + +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays + +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber + +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style + +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./undefineds#daypickerstyles) + +
+ + + + +## toMonth + +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
diff --git a/website/docs/api/getNavigation.mdx b/website/docs/api/getNavigation.mdx new file mode 100644 index 0000000000..a4abc6dd9f --- /dev/null +++ b/website/docs/api/getNavigation.mdx @@ -0,0 +1,500 @@ +--- +id: getnavigation +title: getNavigation +sidebar_label: getNavigation +--- + + +Return the next and the previous months for the navigation component, +according to the DayPicker props. + + + + + +# getNavigation props + + +## className + +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames + +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./undefineds#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components + +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./undefineds#customcomponents) + +
+ + + + +## days + +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./undefineds#daysmodifiers) + +
+ + + + +## daysClassNames + +Change the class names used for the [days modifiers](#days). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./undefineds#daysclassnames) + +
+ + + + +## daysStyles + +Change the inline style for the [days modifiers](#days). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./undefineds#daysstyles) + +
+ + + + +## dir + +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled + +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## enableOutsideDaysClick + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks + +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption + +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./undefineds#monthcaptionformatter) + +
+ + + + +## formatDay + +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./undefineds#dayformatter) + +
+ + + + +## formatWeekNumber + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./undefineds#weeknumberformatter) + +
+ + + + +## formatWeekdayName + +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./undefineds#weekdaynameformatter) + +
+ + + + +## fromMonth + +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden + +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## initialMonth + +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale + +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel + +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths + +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick + +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./undefineds#dayclickeventhandler) + +
+ + + + +## onMonthChange + +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onNextClick + +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onPrevClick + +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## pagedNavigation + +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel + +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected + +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## showCaption + +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead + +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays + +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber + +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style + +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./undefineds#daypickerstyles) + +
+ + + + +## toMonth + +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
diff --git a/website/docs/api/getNavigationProps.mdx b/website/docs/api/getNavigationProps.mdx new file mode 100644 index 0000000000..9150d04ea9 --- /dev/null +++ b/website/docs/api/getNavigationProps.mdx @@ -0,0 +1,499 @@ +--- +id: getnavigationprops +title: getNavigationProps +sidebar_label: getNavigationProps +--- + + +Return the props for the Navigation component and its children. + + + + + +# getNavigationProps props + + +## className + +CSS class to add to the root element. + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## classNames + +Change the class names used by `DayPicker`. + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./undefineds#daypickerclassnames) + +
+ +Use this prop when you need to change the [default class +names](defaultClassNames.mdx) — for example when using CSS modules. + +### Example + +Using custom class names for the head and the caption elements. + +```jsx preview + function App() { + const css = ` + .salmon-head { + color: salmon; + } + .purple-caption { + font-weight: bold; + color: purple; + padding: 3px 0 6px 0; + } + `; + return ( + <> + + + + ); + } +``` + + + +## components + +Customize the internal components. + + +`prop `**`components?:`** [`CustomComponents`](./undefineds#customcomponents) + +
+ + + + +## days + +An object of modifiers. + + +`prop `**`days?:`** [`DaysModifiers`](./undefineds#daysmodifiers) + +
+ + + + +## daysClassNames + +Change the class names used for the [days modifiers](#days). + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./undefineds#daysclassnames) + +
+ + + + +## daysStyles + +Change the inline style for the [days modifiers](#days). + + +`prop `**`daysStyles?:`** [`DaysStyles`](./undefineds#daysstyles) + +
+ + + + +## dir + +The text direction of the calendar. Use `ltr` for left-to-right (default) +or `rtl` for right-to-left. + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## disabled + +Disable the matching days. Disabled days cannot be clicked. + + +`prop `**`disabled?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## enableOutsideDaysClick + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## fixedWeeks + +Display six weeks per months, regardless the month’s number of weeks. Outside +days will be always shown when setting this prop. + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## formatCaption + +Format the month caption text. + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./undefineds#monthcaptionformatter) + +
+ + + + +## formatDay + +Format the content of the day element. + + +`prop `**`formatDay?:`** [`DayFormatter`](./undefineds#dayformatter) + +
+ + + + +## formatWeekNumber + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./undefineds#weeknumberformatter) + +
+ + + + +## formatWeekdayName + +Format the weekday's name in the head element. + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./undefineds#weekdaynameformatter) + +
+ + + + +## fromMonth + +Allow navigation after (and including) the specified month. + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## hidden + +Hide the matching days. + + +`prop `**`hidden?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## initialMonth + +The initial month to show in the calendar. + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## locale + +A locale object to localize +the user interface. + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +
+ + + + +## month + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable months +navigation. + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
+ + + + +## nextLabel + +Label used for the next month button in [Navigation](#navigation). Set it to empty +string to hide the button. + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## numberOfMonths + +The number of months to render. + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +
+ + + + +## onDayClick + +Event handler when the user clicks on a day. + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./undefineds#dayclickeventhandler) + +
+ + + + +## onMonthChange + +Event handler when the month changes. + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onNextClick + +Event handler when the next month button is clicked. + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## onPrevClick + +Event handler when the previous month button is clicked. + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./undefineds#monthchangeeventhandler) + +
+ + + + +## pagedNavigation + +When displaying multiple months, the navigation will be paginated +displaying the [numberOfMonths](#numberofmonths) months at time instead of +one. + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## prevLabel + +Label used for the previous month button in [Navigation](#navigation). Set it to +empty string to hide the button. + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +
+ + + + +## reverseMonths + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) is +greater than `1`, to display the most recent month first. + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## selected + +Apply the `selected` modifiers to the matching days. + + +`prop `**`selected?:`** [`DayMatcher`](./undefineds#daymatcher) + +
+ + + + +## showCaption + +Show the month’s caption. As default, the caption displays month and year. + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showHead + +Show the month’s head. As default, it displays the weekday names according +to [locale](#locale). + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showNavigation + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showOutsideDays + +Show the outside days. An outside day is a day falling in the next or the +previous month. + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## showWeekNumber + +Show the week numbers column. + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +
+ + + + +## style + +Style to apply to the root element. + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +
+ + + + +## styles + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + +`prop `**`styles?:`** [`DayPickerStyles`](./undefineds#daypickerstyles) + +
+ + + + +## toMonth + +Allow navigation before (and including) the specified month. + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +
diff --git a/website/docs/api/getOutsideEndDays.mdx b/website/docs/api/getOutsideEndDays.mdx new file mode 100644 index 0000000000..2f89731aac --- /dev/null +++ b/website/docs/api/getOutsideEndDays.mdx @@ -0,0 +1,15 @@ +--- +id: getoutsideenddays +title: getOutsideEndDays +sidebar_label: getOutsideEndDays +--- + + +Return the outside ending days for the given day. + + + + + +# getOutsideEndDays props + diff --git a/website/docs/api/getOutsideModifier.mdx b/website/docs/api/getOutsideModifier.mdx new file mode 100644 index 0000000000..4e61db8618 --- /dev/null +++ b/website/docs/api/getOutsideModifier.mdx @@ -0,0 +1,15 @@ +--- +id: getoutsidemodifier +title: getOutsideModifier +sidebar_label: getOutsideModifier +--- + + +Return the modifier for days outside the current month. + + + + + +# getOutsideModifier props + diff --git a/website/docs/api/getOutsideStartDays.mdx b/website/docs/api/getOutsideStartDays.mdx new file mode 100644 index 0000000000..a18a68d189 --- /dev/null +++ b/website/docs/api/getOutsideStartDays.mdx @@ -0,0 +1,15 @@ +--- +id: getoutsidestartdays +title: getOutsideStartDays +sidebar_label: getOutsideStartDays +--- + + +Return the outside starting days for the given day. + + + + + +# getOutsideStartDays props + diff --git a/website/docs/api/getWeekdaysNames.mdx b/website/docs/api/getWeekdaysNames.mdx new file mode 100644 index 0000000000..d87a2c4cff --- /dev/null +++ b/website/docs/api/getWeekdaysNames.mdx @@ -0,0 +1,15 @@ +--- +id: getweekdaysnames +title: getWeekdaysNames +sidebar_label: getWeekdaysNames +--- + + +Return the name of the weekdays according to the formatting function. + + + + + +# getWeekdaysNames props + diff --git a/website/docs/api/getWeeks.mdx b/website/docs/api/getWeeks.mdx new file mode 100644 index 0000000000..9e06529dc2 --- /dev/null +++ b/website/docs/api/getWeeks.mdx @@ -0,0 +1,15 @@ +--- +id: getweeks +title: getWeeks +sidebar_label: getWeeks +--- + + +Return the weeks belonging to the given month. + + + + + +# getWeeks props + diff --git a/website/docs/api/interface.mdx b/website/docs/api/interface.mdx new file mode 100644 index 0000000000..0b9f85e614 --- /dev/null +++ b/website/docs/api/interface.mdx @@ -0,0 +1,525 @@ +--- +id: interface +title: Interfaces +--- + + +## DayPickerProps + +The props used by the [DayPicker](#daypicker) component. +
+ + + + + + + + +`prop `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +CSS class to add to the root element. + + + + + +`prop `**`classNames?:`** [`DayPickerClassNames`](./type#daypickerclassnames) + +Change the class names used by `DayPicker`. + + + + + +`prop `**`components?:`** [`CustomComponents`](./type#customcomponents) + +Customize the internal components. + + + + + +`prop `**`days?:`** [`DaysModifiers`](./type#daysmodifiers) + +An object of modifiers. + + + + + +`prop `**`daysClassNames?:`** [`DaysClassNames`](./type#daysclassnames) + +Change the class names used for the [days modifiers](#day). + + + + + +`prop `**`daysStyles?:`** [`DaysStyles`](./type#daysstyles) + +Change the inline style for the [days modifiers](#day). + + + + + +`prop `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +The text direction of the calendar. Use `ltr` for left-to-right (default)or `rtl` for right-to-left. + + + + + +`prop `**`disabled?:`** [`DayMatcher`](./type#daymatcher) + +Disable the matching days. Disabled days cannot be clicked. + + + + + +`prop `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + + + + +`prop `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Display six weeks per months, regardless the month’s number of weeks. Outsidedays will be always shown when setting this prop. + + + + + +`prop `**`formatCaption?:`** [`MonthCaptionFormatter`](./type#monthcaptionformatter) + +Format the month caption text. + + + + + +`prop `**`formatDay?:`** [`DayFormatter`](./type#dayformatter) + +Format the content of the day element. + + + + + +`prop `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./type#weeknumberformatter) + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + + + + +`prop `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./type#weekdaynameformatter) + +Format the weekday's name in the head element. + + + + + +`prop `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +Allow navigation after (and including) the specified month. + + + + + +`prop `**`hidden?:`** [`DayMatcher`](./type#daymatcher) + +Hide the matching days. + + + + + +`prop `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The initial month to show in the calendar. + + + + + +`prop `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +A locale object to localizethe user interface. + + + + + +`prop `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable monthsnavigation. + + + + + +`prop `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +Label used for the next month button in [Navigation](#navigation). Set it to emptystring to hide the button. + + + + + +`prop `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +The number of months to render. + + + + + +`prop `**`onDayClick?:`** [`DayClickEventHandler`](./type#dayclickeventhandler) + +Event handler when the user clicks on a day. + + + + + +`prop `**`onMonthChange?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the month changes. + + + + + +`prop `**`onNextClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the next month button is clicked. + + + + + +`prop `**`onPrevClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the previous month button is clicked. + + + + + +`prop `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +When displaying multiple months, the navigation will be paginateddisplaying the [numberOfMonths](#numberofmonths) months at time instead ofone. + + + + + +`prop `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +Label used for the previous month button in [Navigation](#navigation). Set it toempty string to hide the button. + + + + + +`prop `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) isgreater than `1`, to display the most recent month first. + + + + + +`prop `**`selected?:`** [`DayMatcher`](./type#daymatcher) + +Apply the `selected` modifiers to the matching days. + + + + + +`prop `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the month’s caption. As default, the caption displays month and year. + + + + + +`prop `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the month’s head. As default, it displays the weekday names accordingto [locale](#locale). + + + + + +`prop `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + + + + +`prop `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the outside days. An outside day is a day falling in the next or theprevious month. + + + + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the week numbers column. + + + + + +`prop `**`style?:`** [`CSSProperties`](undefined) + +Style to apply to the root element. + + + + + +`prop `**`styles?:`** [`DayPickerStyles`](./type#daypickerstyles) + +Change the inline styles for each [DayPicker element](./enumerations#daypickerelements). + + + + + +`prop `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +Allow navigation before (and including) the specified month. + + + +## DayProps + +The props used by the [Day](#day) component. +
+ + + + + + + + +`prop `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The month the calendar belongs to. Used to calulate outside days. + + + + + +`prop `**`day:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The day to display in the calendar. + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + +## HeadProps + +The props used by the [Head](#head) component. +
+ + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + + + +`prop `**`locale:`** [`DateFns.Locale`](undefined) + + + + + + + +`prop `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Add a column to accommodate the week numbers. + + + +## MonthCaptionProps + +The props used by the [MonthCaption](#monthcaption) component. +
+ + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + + + +`prop `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The month the caption is referring to. + + + +## MonthTableProps + +Props of the [Month](#month) component. +
+ + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +`prop `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + + + + + +## NavigationProps + +Props for the [Navigation](#navigation) component. +
+ + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + +## WeekNumberProps + +Props for the [WeekNumber](#weeknumber) component. +
+ + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +`prop `**`days:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + + + + + + + +`prop `**`number:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + + + + + +## WeekRowProps + + +
+ + + + + + + + +`prop `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + + + + + + + +`prop `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +`prop `**`week:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + + + + + + + +`prop `**`weekNumber:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + + + + diff --git a/website/docs/api/interfaces.mdx b/website/docs/api/interfaces.mdx new file mode 100644 index 0000000000..beed88c17e --- /dev/null +++ b/website/docs/api/interfaces.mdx @@ -0,0 +1,505 @@ +--- +id: interfaces +title: Interfaces +--- + + +## DayPickerProps + +The props used by the [DayPicker](#daypicker) component. + + + + + + + +` `**`className?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +CSS class to add to the root element. + + + + + +` `**`classNames?:`** [`DayPickerClassNames`](./type#daypickerclassnames) + +Change the class names used by `DayPicker`. + + + + + +` `**`components?:`** [`CustomComponents`](./type#customcomponents) + +Customize the internal components. + + + + + +` `**`days?:`** [`DaysModifiers`](./type#daysmodifiers) + +An object of modifiers. + + + + + +` `**`daysClassNames?:`** [`DaysClassNames`](./type#daysclassnames) + +Change the class names used for the [days modifiers](#days). + + + + + +` `**`daysStyles?:`** [`DaysStyles`](./type#daysstyles) + +Change the inline style for the [days modifiers](#days). + + + + + +` `**`dir?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +The text direction of the calendar. Use `ltr` for left-to-right (default)or `rtl` for right-to-left. + + + + + +` `**`disabled?:`** [`DayMatcher`](./type#daymatcher) + +Disable the matching days. Disabled days cannot be clicked. + + + + + +` `**`enableOutsideDaysClick?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Enable click event for outside days when [showOutsideDays](#showoutsidedays) is used. + + + + + +` `**`fixedWeeks?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Display six weeks per months, regardless the month’s number of weeks. Outsidedays will be always shown when setting this prop. + + + + + +` `**`formatCaption?:`** [`MonthCaptionFormatter`](./type#monthcaptionformatter) + +Format the month caption text. + + + + + +` `**`formatDay?:`** [`DayFormatter`](./type#dayformatter) + +Format the content of the day element. + + + + + +` `**`formatWeekNumber?:`** [`WeekNumberFormatter`](./type#weeknumberformatter) + +Format the week numbers (when [showWeekNumber](#showweeknumber) is set). + + + + + +` `**`formatWeekdayName?:`** [`WeekdayNameFormatter`](./type#weekdaynameformatter) + +Format the weekday's name in the head element. + + + + + +` `**`fromMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +Allow navigation after (and including) the specified month. + + + + + +` `**`hidden?:`** [`DayMatcher`](./type#daymatcher) + +Hide the matching days. + + + + + +` `**`initialMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The initial month to show in the calendar. + + + + + +` `**`locale?:`** [`dateFns.Locale`](https://date-fns.org/docs/Locale) + +A locale object to localizethe user interface. + + + + + +` `**`month?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The rendered month. Implement [onMonthChange](#onmonthchange) to enable monthsnavigation. + + + + + +` `**`nextLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +Label used for the next month button in [Navigation](#navigation). Set it to emptystring to hide the button. + + + + + +` `**`numberOfMonths?:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + +The number of months to render. + + + + + +` `**`onDayClick?:`** [`DayClickEventHandler`](./type#dayclickeventhandler) + +Event handler when the user clicks on a day. + + + + + +` `**`onMonthChange?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the month changes. + + + + + +` `**`onNextClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the next month button is clicked. + + + + + +` `**`onPrevClick?:`** [`MonthChangeEventHandler`](./type#monthchangeeventhandler) + +Event handler when the previous month button is clicked. + + + + + +` `**`pagedNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +When displaying multiple months, the navigation will be paginateddisplaying the [numberOfMonths](#numberofmonths) months at time instead ofone. + + + + + +` `**`prevLabel?:`** [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/string) + +Label used for the previous month button in [Navigation](#navigation). Set it toempty string to hide the button. + + + + + +` `**`reverseMonths?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Render the months in reversed order. Useful when [numberOfMonths](#numberofmonths) isgreater than `1`, to display the most recent month first. + + + + + +` `**`selected?:`** [`DayMatcher`](./type#daymatcher) + +Apply the `selected` modifiers to the matching days. + + + + + +` `**`showCaption?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the month’s caption. As default, the caption displays month and year. + + + + + +` `**`showHead?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the month’s head. As default, it displays the weekday names accordingto [locale](#locale). + + + + + +` `**`showNavigation?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the navigation bar. [onMonthChange](#onmonthchange) must be set. + + + + + +` `**`showOutsideDays?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the outside days. An outside day is a day falling in the next or theprevious month. + + + + + +` `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Show the week numbers column. + + + + + +` `**`style?:`** [`CSSProperties`](undefined) + +Style to apply to the root element. + + + + + +` `**`styles?:`** [`DayPickerStyles`](./type#daypickerstyles) + +Inline styles to apply to the [DayPickerElements](#daypickerelements). + + + + + +` `**`toMonth?:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +Allow navigation before (and including) the specified month. + + + +## DayProps + +The props used by the [Day](#day) component. + + + + + + + +` `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The month the calendar belongs to. Used to calulate outside days. + + + + + +` `**`day:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The day to display in the calendar. + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + +## HeadProps + +The props used by the [Head](#head) component. + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + + + +` `**`locale:`** [`DateFns.Locale`](undefined) + + + + + + + +` `**`showWeekNumber?:`** [`boolean`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/boolean) + +Add a column to accommodate the week numbers. + + + +## MonthCaptionProps + +The props used by the [MonthCaption](#monthcaption) component. + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + +Reference to the props used by the DayPicker component. + + + + + +` `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + +The month the caption is referring to. + + + +## MonthTableProps + +Props of the [Month](#month) component. + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +` `**`month:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + + + + + +## NavigationProps + +Props for the [Navigation](#navigation) component. + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + +## WeekNumberProps + +Props for the [WeekNumber](#weeknumber) component. + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +` `**`days:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + + + + + + + +` `**`number:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) + + + + + +## WeekRowProps + + + + + + + + + +` `**`currentMonth:`** [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) + + + + + + + +` `**`dayPickerProps:`** [`DayPickerProps`](./interface#daypickerprops) + + + + + + + +` `**`week:`** [[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date)] + + + + + + + +` `**`weekNumber:`** [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/number) diff --git a/website/docs/api/isDayAfter.mdx b/website/docs/api/isDayAfter.mdx new file mode 100644 index 0000000000..6fe02a6e2b --- /dev/null +++ b/website/docs/api/isDayAfter.mdx @@ -0,0 +1,15 @@ +--- +id: isdayafter +title: isDayAfter +sidebar_label: isDayAfter +--- + + +Return true if `day1` is after `day2`. + + + + + +# isDayAfter props + diff --git a/website/docs/api/isDayBefore.mdx b/website/docs/api/isDayBefore.mdx new file mode 100644 index 0000000000..a1ac970714 --- /dev/null +++ b/website/docs/api/isDayBefore.mdx @@ -0,0 +1,15 @@ +--- +id: isdaybefore +title: isDayBefore +sidebar_label: isDayBefore +--- + + +Return true if `day1` is before `day2`. + + + + + +# isDayBefore props + diff --git a/website/docs/api/isValidDate.mdx b/website/docs/api/isValidDate.mdx new file mode 100644 index 0000000000..e41663ae0f --- /dev/null +++ b/website/docs/api/isValidDate.mdx @@ -0,0 +1,15 @@ +--- +id: isvaliddate +title: isValidDate +sidebar_label: isValidDate +--- + + + + + + + + +# isValidDate props + diff --git a/website/docs/api/matchDate.mdx b/website/docs/api/matchDate.mdx new file mode 100644 index 0000000000..aad4cfb9cf --- /dev/null +++ b/website/docs/api/matchDate.mdx @@ -0,0 +1,15 @@ +--- +id: matchdate +title: matchDate +sidebar_label: matchDate +--- + + +Return true if `day` matches the given [DayMatcher](#daymatcher). + + + + + +# matchDate props + diff --git a/website/docs/api/matchDay.mdx b/website/docs/api/matchDay.mdx new file mode 100644 index 0000000000..d23d716da9 --- /dev/null +++ b/website/docs/api/matchDay.mdx @@ -0,0 +1,15 @@ +--- +id: matchday +title: matchDay +sidebar_label: matchDay +--- + + +Return `true` if a day matches a day matcher. + + + + + +# matchDay props + diff --git a/website/docs/api/matchDayAfter.mdx b/website/docs/api/matchDayAfter.mdx new file mode 100644 index 0000000000..415b6308bd --- /dev/null +++ b/website/docs/api/matchDayAfter.mdx @@ -0,0 +1,15 @@ +--- +id: matchdayafter +title: matchDayAfter +sidebar_label: matchDayAfter +--- + + +TODO: write docs + + + + + +# matchDayAfter props + diff --git a/website/docs/api/matchDayBefore.mdx b/website/docs/api/matchDayBefore.mdx new file mode 100644 index 0000000000..e66b33af68 --- /dev/null +++ b/website/docs/api/matchDayBefore.mdx @@ -0,0 +1,15 @@ +--- +id: matchdaybefore +title: matchDayBefore +sidebar_label: matchDayBefore +--- + + +TODO: write docs + + + + + +# matchDayBefore props + diff --git a/website/docs/api/matchDayBetween.mdx b/website/docs/api/matchDayBetween.mdx new file mode 100644 index 0000000000..68cf4cd0c7 --- /dev/null +++ b/website/docs/api/matchDayBetween.mdx @@ -0,0 +1,15 @@ +--- +id: matchdaybetween +title: matchDayBetween +sidebar_label: matchDayBetween +--- + + +TODO: write docs + + + + + +# matchDayBetween props + diff --git a/website/docs/api/matchDayInRange.mdx b/website/docs/api/matchDayInRange.mdx new file mode 100644 index 0000000000..956a23f68c --- /dev/null +++ b/website/docs/api/matchDayInRange.mdx @@ -0,0 +1,15 @@ +--- +id: matchdayinrange +title: matchDayInRange +sidebar_label: matchDayInRange +--- + + +Returns true if the day is in the range specified by the [DayMatcher](#daymatcher). + + + + + +# matchDayInRange props + diff --git a/website/docs/api/matchDayOfWeek.mdx b/website/docs/api/matchDayOfWeek.mdx new file mode 100644 index 0000000000..3392e2becf --- /dev/null +++ b/website/docs/api/matchDayOfWeek.mdx @@ -0,0 +1,15 @@ +--- +id: matchdayofweek +title: matchDayOfWeek +sidebar_label: matchDayOfWeek +--- + + +TODO: write docs + + + + + +# matchDayOfWeek props + diff --git a/website/docs/api/matchFunction.mdx b/website/docs/api/matchFunction.mdx new file mode 100644 index 0000000000..74b40bbc85 --- /dev/null +++ b/website/docs/api/matchFunction.mdx @@ -0,0 +1,15 @@ +--- +id: matchfunction +title: matchFunction +sidebar_label: matchFunction +--- + + +TODO: write docs + + + + + +# matchFunction props + diff --git a/website/docs/api/reduceCallback.mdx b/website/docs/api/reduceCallback.mdx new file mode 100644 index 0000000000..c6bd5163fb --- /dev/null +++ b/website/docs/api/reduceCallback.mdx @@ -0,0 +1,15 @@ +--- +id: reducecallback +title: reduceCallback +sidebar_label: reduceCallback +--- + + + + + + + + +# reduceCallback props + diff --git a/website/docs/api/type.mdx b/website/docs/api/type.mdx new file mode 100644 index 0000000000..db593ff031 --- /dev/null +++ b/website/docs/api/type.mdx @@ -0,0 +1,236 @@ +--- +id: type +title: Types +--- + + + +## CaptionHtmlProps + +Props for the #{} + + + + +## CustomComponents + +Components that can be replaced + + + + +## DayClickEventHandler + +Event handler when a day is clicked. + + + + +## DayContainerHtmlProps + + + + + + +## DayFormatter + +A function that format the day for the [Day](#day) component. + + + + +## DayHtmlProps + + + + + + +## DayMatchModifier + +A type to indicate when a day matches a modifier. + + + + +## DayMatcher + +Day matchers are used to find if a day matches a specific condition, like +being between two dates, or in a specified day of the week, etc. + + + + +## DayModifier + +A modifier is a string attached to a day whose behavior and appearance is meant to be modified by it. + + + + +## DayPickerClassNames + +An object defining the CSS class names for each [DayPicker +element](./enumerations#daypickerelements). + + + + +## DayPickerStyles + +An object defining the inline style for each [DayPicker +element](./enumerations#daypickerelements). + + + + +## DayWrapperHtmlProps + + + + + + +## DaysClassNames + + + + + + +## DaysModifiers + +Modifiers to assign when a day is matched. + + + + +## DaysStyles + +Inline styles to apply to the day element having the specified modifier. + + + + +## MatchDate + +Matches a day that is the same as the specified date. + + + + +## MatchDayAfter + +Matches the days after (but not including) the specified date. + + + + +## MatchDayBefore + +Matches the days before (but not including) the specified date. + + + + +## MatchDayBetween + +Matches the days between (but not including) the specified dates. + + + + +## MatchDayInRange + +Matches the days that are inside (but not including) the specified range. + + + + +## MatchDaysOfWeek + +Matches one or more days of the week (`0` = Sundays). + + + + +## MatchFunction + +Matches any day for which this function returns a truthy value. + + + + +## MatchingModifiers + +An object containing modifiers matching a specific day. Some defaults +modifiers are used in `DayPicker`. They can be extended using the +[[DayPickerProps.days]] prop. + + + + +## MonthCaptionFormatter + +A function that format a month for the [MonthCaption](#monthcaption) component. + + + + +## MonthChangeEventHandler + +Event handler when the month is changed. + + + + +## MonthWeeks + +The weeks belonging to a month. Each key of the returned object is the +week number of the year. + + + + +## NavigationHtmlProps + +HTML props for the [Navigation](#navigation). + + + + +## NavigationMonths + +The months that is possible to navigate. + + + + +## UseInputDayPickerProps + +Props to attach to the DayPicker component + + + + +## UseInputInputProps + +Props to attach to the `input` HTML element + + + + +## WeekNumberFormatter + + + + + + +## WeekdayNameFormatter + +Format the weekday name. + + + diff --git a/website/docs/api/useInput.mdx b/website/docs/api/useInput.mdx new file mode 100644 index 0000000000..fac8aecbd2 --- /dev/null +++ b/website/docs/api/useInput.mdx @@ -0,0 +1,26 @@ +--- +id: useinput +title: useInput +sidebar_label: useInput +--- + + +Hook to bind a input with a calendar. + +```jsx +const { + month, + selected, + dayPickerProps, + inputProps +} = useInput(new Date()); + + + +``` + + + + +# useInput props + diff --git a/website/docs/api/useModifiers.mdx b/website/docs/api/useModifiers.mdx new file mode 100644 index 0000000000..b866d8d5d9 --- /dev/null +++ b/website/docs/api/useModifiers.mdx @@ -0,0 +1,15 @@ +--- +id: usemodifiers +title: useModifiers +sidebar_label: useModifiers +--- + + +Get the modifiers for the specified day. + + + + + +# useModifiers props + diff --git a/website/docs/custom-components.mdx b/website/docs/custom-components.mdx index e9821f92db..5f015334d6 100644 --- a/website/docs/custom-components.mdx +++ b/website/docs/custom-components.mdx @@ -5,10 +5,10 @@ title: Custom Components > Extend DayPicker by replacing its internal component. -Use the [components prop](./reference/props.mdx#components) to replace +Use the [components prop](./api/daypicker#components) to replace DayPicker’s internals with your own components: -* `Caption` – used to render the caption; +* `MonthCaption` – used to render the caption; * `Navigation` – used to render the month navigation; * `WeekNumber` – used to render the week numbers; * `Day` – used to render the day. @@ -19,17 +19,17 @@ This guide is still a work in progress. ::: -## Caption component +## MonthCaption component -The `Caption` component is used to render the caption (with month/year) in the calendar. +The `MonthCaption` component is used to render the caption (with month/year) in the calendar. To use a custom Caption component, -1. create a `Caption` component with `month` and `dayPickerProps` props; +1. create a `MonthCaption` component with `month` and `dayPickerProps` props; 2. (optional) get DayPicker-specific props via [getCaptionProps](./utils#getCaptionProps); -3. pass the `Caption` component to the `components` prop. +3. pass the `MonthCaption` component to the `components` prop. -For example, the following DayPicker implements a `Caption` component to switch the month of the current year: +For example, the following DayPicker implements a `MonthCaption` component to switch the month of the current year: ```jsx preview import { DayPicker, getCaptionProps } from 'react-day-picker'; @@ -53,7 +53,7 @@ function App() { ); } - function Caption({ month, dayPickerProps }) { + function MonthCaption({ month, dayPickerProps }) { const { locale, onCaptionMonthChange } = dayPickerProps; const { containerProps } = getCaptionProps(dayPickerProps); @@ -76,7 +76,7 @@ function App() { month={month} onMonthChange={setMonth} onCaptionMonthChange={handleCaptionMonthChange} - components={{ Caption }} + components={{ MonthCaption }} /> ); } @@ -162,7 +162,7 @@ function App() { The `Day` component is used to render the day in the calendar. :::caution -Changing Day component is an advanced feature may break accessibility and require some familiarity with DayPicker. If you need to change the content of the day cell, use the [formatDay prop](./reference/props.mdx#formatDay). +Changing Day component is an advanced feature may break accessibility and require some familiarity with DayPicker. If you need to change the content of the day cell, use the [formatDay prop](./api/daypicker#formatDay). ::: To use a custom Day component, you will need thye diff --git a/website/docs/examples.mdx b/website/docs/examples.mdx index 9c02aeaed5..b3ff1e1fef 100644 --- a/website/docs/examples.mdx +++ b/website/docs/examples.mdx @@ -8,7 +8,7 @@ title: Examples ## Selecting days To display days as selected, pass one or more dates to the [selected -prop](./reference/props.mdx#selected). You can also use ranges or other values +prop](./api/daypicker#selected). You can also use ranges or other values to [match days](./modifiers-matching-days.mdx). ```jsx preview @@ -28,7 +28,7 @@ function App() { ``` To make days selectable when clicked, add a state to the component and bind it -to the [onDayClick event handler](./reference/props.mdx#onDayClick). +to the [onDayClick event handler](./api/daypicker#onDayClick). ```jsx preview function App() { @@ -46,7 +46,7 @@ function App() { ## Disabling days -To disable days, pass them to the [disabled](./reference/props.mdx#disabled) +To disable days, pass them to the [disabled](./api/daypicker#disabled) prop. Disabled days cannot be clicked. You can also use ranges or other values to [match days](./modifiers-matching-days.mdx). @@ -65,7 +65,25 @@ function App() { ## Hiding days -TODO: write docs +Like with the disabled days, pass a [hidden prop](./api/daypicker#disabled) +to hide days from the calendar. + +```jsx preview +function App() { + const today = new Date(); + const sundays = { daysOfWeek: [0] }; + return ( +