Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add typings to some examples #2231

Merged
merged 14 commits into from
Jul 7, 2024
Merged

docs: add typings to some examples #2231

merged 14 commits into from
Jul 7, 2024

Conversation

dave-meyer
Copy link
Contributor

@dave-meyer dave-meyer commented Jun 24, 2024

Description

The previous code examples on the website sometimes used untyped 'useState' hooks. This made it sometimes difficult to understand the code. My changes add strong typing (i.e. useState<Date>()) to wherever the code was not self explanatory.

Also, these changes unify the code examples, since some of them had strongly typed hooks and others did not.

Type of Change

  • Documentation update

Checklist

Before submitting your pull request, please make sure the following is done:

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works (not needed)
  • I have added necessary documentation (if appropriate)
  • I have followed the coding guidelines in this project
  • I have tested my changes on different browsers and screen sizes (not needed)

Linked Issues

None

Test Plan

Not needed

Screenshots (if appropriate)

Not needed

Further Comments

None

dave-meyer and others added 8 commits June 24, 2024 19:18
Used strongly-typed useState<Date>(...) hook
Used strongly-typed useState<Date>(...) hook
Used strongly-typed useState<Date>(...) hook
Used strongly-typed useState<Date>(...) hook
@dave-meyer
Copy link
Contributor Author

I think this PR is ready for review/merge now.

Copy link
Owner

@gpbl gpbl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your update. Not all the changes are correct, however - would you mind to fix these? Thanks again.

README.md Outdated Show resolved Hide resolved
website/docs/start.mdx Outdated Show resolved Hide resolved
website/docs/using-daypicker/navigation.mdx Outdated Show resolved Hide resolved
website/docs/using-daypicker/selection-modes.mdx Outdated Show resolved Hide resolved
website/docs/using-daypicker/selection-modes.mdx Outdated Show resolved Hide resolved
@gpbl gpbl changed the title Unified example code on website regarding useState hooks docs: add typings to some examples Jul 7, 2024
gpbl and others added 6 commits July 7, 2024 14:04
Date can also be undefined

Co-authored-by: Giampaolo Bellavite <[email protected]>
Date can also be undefined

Co-authored-by: Giampaolo Bellavite <[email protected]>
Removed unneeded typing

Co-authored-by: Giampaolo Bellavite <[email protected]>
Added Date array type

Co-authored-by: Giampaolo Bellavite <[email protected]>
Removed unneeded/obvious typing

Co-authored-by: Giampaolo Bellavite <[email protected]>
@dave-meyer
Copy link
Contributor Author

Thank you for reviewing! I commited your requested changes.

@gpbl
Copy link
Owner

gpbl commented Jul 7, 2024

Thanks you, @dave-meyer !

@gpbl gpbl merged commit 33daf06 into gpbl:main Jul 7, 2024
8 checks passed
Brooooooklyn referenced this pull request in toeverything/AFFiNE Sep 3, 2024
This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [react-day-picker](https://daypicker.dev) ([source](https://github.com/gpbl/react-day-picker)) | [`^8.10.1` -> `^9.0.0`](https://renovatebot.com/diffs/npm/react-day-picker/8.10.1/9.0.8) | [![age](https://developer.mend.io/api/mc/badges/age/npm/react-day-picker/9.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/react-day-picker/9.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/react-day-picker/8.10.1/9.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/react-day-picker/8.10.1/9.0.8?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>gpbl/react-day-picker (react-day-picker)</summary>

### [`v9.0.8`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.8)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.7...v9.0.8)

This release fixes a regression in v9.0.7 affecting range mode.

#### What's Changed

-   fix: update the displayed month only if start/end month change by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2358](https://github.com/gpbl/react-day-picker/pull/2358)

**Full Changelog**: gpbl/react-day-picker@v9.0.7...v9.0.8

### [`v9.0.7`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.7)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.6...v9.0.7)

This release improves compatibility with v8 and fix an issue with the calendar navigation.

#### What's Changed

-   fix: update calendar state when `startMonth` or `endMonth` change by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2343](https://github.com/gpbl/react-day-picker/pull/2343)
-   feat: allow partial locales, export `defaultLocale` by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2348](https://github.com/gpbl/react-day-picker/pull/2348)
-   feat: allow `undefined` as initially selected value, as it was in v8 by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2341](https://github.com/gpbl/react-day-picker/pull/2341)
-   docs: changed class name `calendar` to  `root` in the examples by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2347](https://github.com/gpbl/react-day-picker/pull/2347)
-   docs: replaced deprecated props by [@&#8203;josephmarkus](https://github.com/josephmarkus) in [https://github.com/gpbl/react-day-picker/pull/2336](https://github.com/gpbl/react-day-picker/pull/2336)\*

#### New Contributors

-   [@&#8203;josephmarkus](https://github.com/josephmarkus) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2336](https://github.com/gpbl/react-day-picker/pull/2336)

**Full Changelog**: gpbl/react-day-picker@v9.0.6...v9.0.7

### [`v9.0.6`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.6)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.5...v9.0.6)

This release addresses the failed import of the common-js module for some app builder and add new `data-` attributes to help the integration with Tailwind. Thanks for your feedback!

#### What's Changed

-   fix(build): add package.json to dist/cjs module by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2330](https://github.com/gpbl/react-day-picker/pull/2330)
-   feat: add new data-attributes to the day cells by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2331](https://github.com/gpbl/react-day-picker/pull/2331)

#### New Contributors

-   [@&#8203;lesleh](https://github.com/lesleh) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2329](https://github.com/gpbl/react-day-picker/pull/2329)

**Full Changelog**: gpbl/react-day-picker@v9.0.5...v9.0.6

### [`v9.0.5`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.5)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.4...v9.0.5)

This release improves the range mode behavior (see the [updated docs](https://daypicker.dev/docs/selection-modes#range-mode)) and address some styling issues.

#### What's Changed

-   fix: improved range mode to work with min / required props by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2326](https://github.com/gpbl/react-day-picker/pull/2326)
-   fix(style): typo in css rdp-hidden module css breaking CSS builds by [@&#8203;ayuhito](https://github.com/ayuhito) in [https://github.com/gpbl/react-day-picker/pull/2307](https://github.com/gpbl/react-day-picker/pull/2307)
-   fix(style): borders grid are not collapsed by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2323](https://github.com/gpbl/react-day-picker/pull/2323)
-   fix(style): week numbers are now centered by [@&#8203;gpbl](https://github.com/gpbl) in gpbl/react-day-picker@c919ad8

#### New Contributors

-   [@&#8203;ayuhito](https://github.com/ayuhito) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2307](https://github.com/gpbl/react-day-picker/pull/2307)
-   [@&#8203;rishabh-ink](https://github.com/rishabh-ink) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2311](https://github.com/gpbl/react-day-picker/pull/2311)

**Full Changelog**: gpbl/react-day-picker@v9.0.4...v9.0.5

### [`v9.0.4`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.4)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.3...v9.0.4)

This release fixes some bugs and improves compatibility with v8.10. Thanks for your feedback and patience! 🤖

#### What's Changed

-   fix(css): typo in `.rdp-range_end` by [@&#8203;AlessioDP](https://github.com/AlessioDP) in [https://github.com/gpbl/react-day-picker/pull/2298](https://github.com/gpbl/react-day-picker/pull/2298)
-   fix(css): dropdown is transparent in Windows OS by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2300](https://github.com/gpbl/react-day-picker/pull/2300)
-   fix: `endMonth` date not working as expected by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2301](https://github.com/gpbl/react-day-picker/pull/2301)
-   feat: added back `onDayMouseEnter` and `onDayMouseLeave` by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2304](https://github.com/gpbl/react-day-picker/pull/2304)

#### New Contributors

-   [@&#8203;AlessioDP](https://github.com/AlessioDP) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2298](https://github.com/gpbl/react-day-picker/pull/2298)

**Full Changelog**: gpbl/react-day-picker@v9.0.3...v9.0.4

### [`v9.0.3`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.3)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.2...v9.0.3)

This release fixes two issues found with the grid style and the range mode.

#### What's Changed

-   fix: alignment of grid elements by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2294](https://github.com/gpbl/react-day-picker/pull/2294)
-   fix: range mode not updating when selected prop changes by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2295](https://github.com/gpbl/react-day-picker/pull/2295)

**Full Changelog**: gpbl/react-day-picker@v9.0.2...v9.0.3

### [`v9.0.2`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.2)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.1...v9.0.2)

This update improves backward compatibility with v8.10.1 for range selection mode.

#### What's Changed

-   feat: add `excludeDisabled` prop for range mode by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2290](https://github.com/gpbl/react-day-picker/pull/2290)

**Full Changelog**: gpbl/react-day-picker@v9.0.1...v9.0.2

### [`v9.0.1`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.1)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v9.0.0...v9.0.1)

This update improves backward compatibility with v8.10.1.

#### What's Changed

-   fix: prop types not being correctly interpreted by TS by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2283](https://github.com/gpbl/react-day-picker/pull/2283)
-   feat: add `DeprecatedUI` enum by [@&#8203;gpbl](https://github.com/gpbl) in [https://github.com/gpbl/react-day-picker/pull/2284](https://github.com/gpbl/react-day-picker/pull/2284)

**Full Changelog**: gpbl/react-day-picker@v9.0.0...v9.0.1

### [`v9.0.0`](https://github.com/gpbl/react-day-picker/releases/tag/v9.0.0)

[Compare Source](https://github.com/gpbl/react-day-picker/compare/v8.10.1...v9.0.0)

DayPicker v9 is a major release including significant updates related to accessibility, customization and localization.

-   See the updated docs at https://daypicker.dev and the [upgrading Guide](https://daypicker.dev/upgrading) for more details.

##### Install the Latest Version

```bash
npm install react-day-picker@latest
```

#### What’s New

-   Moved `date-fns` from peer dependencies to dependencies.
-   Added support for [UTC dates](https://daypicker.dev/docs/localization#utc-dates) and [Jalali Calendar](https://daypicker.dev/docs/localization#jalali-calendar).
-   [Enhanced accessibility](https://daypicker.dev/docs/accessibility) to better comply with [WCAG 2.1](https://www.w3.org/TR/WCAG21/) recommendations.
-   [Simplified styles](https://daypicker.dev/docs/styling) and new CSS variables for easier customization.
-   Improved selection logic for [range mode](https://daypicker.dev/docs/selection-modes.mdx).
-   New `dropdown-years` and `dropdown-months` caption layouts.
-   New `hideWeekdayRow` and `hideNavigation` props.
-   Updated for a complete [custom components](https://daypicker.dev/guides/custom-components) support.
-   Improved typings and props for better compatibility in TypeScript `strict` mode.

#### Breaking Changes

While we tried to keep the API as stable as possible, some breaking changes were necessary to improve the library:

-   The updated ARIA labels could require new translations or updated unit tests selectors.
-   Custom CSS styles will likely break, due to the updated CSS classes and simplified styles.
-   Custom Components have new API and may break.
-   Some typings have been renamed or deprecated.
-   The `useInput` hook has been removed. See [Input fields](https://daypicker.dev/guides/input-fields) guide for more details.
-   `onWeekNumberClick` has been removed. Use a custom component to handle week number clicks.
-   The updated build system to ESM and CommonJS could break some custom bundler.

##### Upgrading Guide

We prepared a [Upgrading guide](https://daypicker.dev/upgrading) for help upgrading your app to v9. We welcome [feedback](https://github.com/gpbl/react-day-picker/discussions) about the upgrade process, to ensure it's smooth for everyone.

#### Compatibility

DayPicker v9 is compatible with React 16.8+.

#### Get Support and Report Issues

Get support, report issues, and provide feedback on the [Discussion forums](https://github.com/gpbl/react-day-picker/discussions). Thanks.

#### New Contributors

-   [@&#8203;grzegorzpokorski](https://github.com/grzegorzpokorski) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2124](https://github.com/gpbl/react-day-picker/pull/2124)
-   [@&#8203;zaaakher](https://github.com/zaaakher) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2137](https://github.com/gpbl/react-day-picker/pull/2137)
-   [@&#8203;ArthurGoupil](https://github.com/ArthurGoupil) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2230](https://github.com/gpbl/react-day-picker/pull/2230)
-   [@&#8203;johnnysedh3lllo](https://github.com/johnnysedh3lllo) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2252](https://github.com/gpbl/react-day-picker/pull/2252)
-   [@&#8203;xardit](https://github.com/xardit) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2254](https://github.com/gpbl/react-day-picker/pull/2254)
-   [@&#8203;dave-meyer](https://github.com/dave-meyer) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2231](https://github.com/gpbl/react-day-picker/pull/2231)
-   [@&#8203;benasher44](https://github.com/benasher44) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2249](https://github.com/gpbl/react-day-picker/pull/2249)
-   [@&#8203;RyanCavanaugh](https://github.com/RyanCavanaugh) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2275](https://github.com/gpbl/react-day-picker/pull/2275)
-   [@&#8203;kesoji](https://github.com/kesoji) made their first contribution in [https://github.com/gpbl/react-day-picker/pull/2281](https://github.com/gpbl/react-day-picker/pull/2281)

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/toeverything/AFFiNE).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40MzEuNCIsInVwZGF0ZWRJblZlciI6IjM4LjU5LjIiLCJ0YXJnZXRCcmFuY2giOiJjYW5hcnkiLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants