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

fix(docs): i18n version in date-related components #4430

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Dec 22, 2024

Closes #

📝 Description

currently production is using @react-aria/i18n@3.12.4. therefore, update the correct version so that users can use the exact same version as our codebase.

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions for the DateInput, DatePicker, and DateRangePicker components to reflect the latest version of the @react-aria/i18n package (3.12.4).
    • Enhanced descriptions of component features, props, and API details for better clarity and usability.

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Dec 22, 2024
Copy link

changeset-bot bot commented Dec 22, 2024

⚠️ No Changeset found

Latest commit: 8a0f445

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 3:12pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 3:12pm

Copy link
Contributor

coderabbitai bot commented Dec 22, 2024

Walkthrough

The pull request focuses on updating the documentation for three date-related components: DateInput, DatePicker, and DateRangePicker. The primary change involves updating the @react-aria/i18n package version from 3.12.2 to 3.12.4 across installation instructions for multiple package managers. The documentation updates include refined descriptions of component properties, usage examples, and API details, ensuring users have the most current and accurate guidance for implementing these components.

Changes

File Change Summary
apps/docs/content/docs/components/date-input.mdx - Updated @react-aria/i18n package version to 3.12.4 in installation commands
- Enhanced documentation on component features and props
apps/docs/content/docs/components/date-picker.mdx - Updated @react-aria/i18n package version to 3.12.4 in installation commands
- Refined documentation on component properties and usage
apps/docs/content/docs/components/date-range-picker.mdx - Updated @react-aria/i18n package version to 3.12.4 in installation commands
- Expanded API section with detailed prop and event descriptions

Possibly related PRs

Suggested reviewers

  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 885c9b3 and 8a0f445.

📒 Files selected for processing (3)
  • apps/docs/content/docs/components/date-input.mdx (2 hunks)
  • apps/docs/content/docs/components/date-picker.mdx (4 hunks)
  • apps/docs/content/docs/components/date-range-picker.mdx (5 hunks)
🔇 Additional comments (3)
apps/docs/content/docs/components/date-input.mdx (1)

132-134: LGTM! Package version updates are consistent.

The @react-aria/i18n package version has been correctly updated to 3.12.4 across all installation commands.

Also applies to: 180-182

apps/docs/content/docs/components/date-picker.mdx (1)

147-149: LGTM! Package version updates are consistent.

The @react-aria/i18n package version has been correctly updated to 3.12.4 across all installation commands.

Also applies to: 195-197, 217-219, 249-251

apps/docs/content/docs/components/date-range-picker.mdx (1)

164-166: LGTM! Package version updates are consistent.

The @react-aria/i18n package version has been correctly updated to 3.12.4 across all installation commands.

Also applies to: 212-214, 234-236, 259-261, 279-281


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@jrgarciadev jrgarciadev merged commit 5cd1c63 into main Dec 22, 2024
3 checks passed
@jrgarciadev jrgarciadev deleted the fix/i18n-version branch December 22, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Scope : Docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants