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.

Sign up for GitHub

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

feat(docs): revise breaking changes content #3001

Closed
wants to merge 2 commits into from
Closed

feat(docs): revise breaking changes content #3001

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1a6a1a
feat(docs): revise breaking changes content
wingkwong May 14, 2024
554673f
refactor(docs): revise wordings
wingkwong May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions apps/docs/content/blog/v2.3.0.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,9 @@ export function Providers({children}: ProvidersProps) {

## Breaking Changes

In order to improve the performance and reduce the bundle size, we have removed the `units` creation from the
### Removal of the `units` creation

Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify the phrase "In order to".

- In order to improve the performance and reduce the bundle size,
+ To improve performance and reduce bundle size,
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
To improve performance and reduce bundle size,

To improve performance and reduce bundle size, we have removed the `units` creation from the
`nextui` plugin. [TailwindCSS v3.4](https://tailwindcss.com/blog/tailwindcss-v3-4) added support for `min-h-*` and `min-w-*` classes, so it is no longer needed.

How to upgrade:
Expand Down Expand Up @@ -335,8 +337,28 @@ export const MyButton = () => {
};
```

That's it! Your project should now be using the latest version of TailwindCSS and NextUI.
### Separation for `errorMessage` and `isInvalid`

We are currently working on supporting multiple types of validation, including native HTML constraint validation, custom validation, and real-time validation.
Due to this reason, the requirements for displaying error messages have become more varied, and it is necessary to handle validation conditions separately from the `errorMessage`.

Comment on lines +342 to +344
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify the phrase "Due to this reason".

- Due to this reason, the requirements for displaying error messages have become more varied, and it is necessary to handle validation conditions separately from the `errorMessage`.
+ Therefore, the requirements for displaying error messages have become more varied, and it is necessary to handle validation conditions separately from the `errorMessage`.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
We are currently working on supporting multiple types of validation, including native HTML constraint validation, custom validation, and real-time validation.
Due to this reason, the requirements for displaying error messages have become more varied, and it is necessary to handle validation conditions separately from the `errorMessage`.
We are currently working on supporting multiple types of validation, including native HTML constraint validation, custom validation, and real-time validation.
Therefore, the requirements for displaying error messages have become more varied, and it is necessary to handle validation conditions separately from the `errorMessage`.

How to upgrade:

1. To display `errorMessage`, `isInvalid` must be set to `true`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Simplify the phrase "In order to".

- In order to display `errorMessage`, `isInvalid` has to be set to `true`.
+ To display `errorMessage`, `isInvalid` must be set to `true`.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
1. To display `errorMessage`, `isInvalid` must be set to `true`.
1. To display `errorMessage`, `isInvalid` must be set to `true`.


```diff-jsx
<Input
type="email"
label="Email"
variant="bordered"
defaultValue="junior2nextui.org"
+ isInvalid={true}
errorMessage="Please enter a valid email"
className="max-w-xs"
/>
```

That's it! Your project should now be using the latest version of TailwindCSS and NextUI.

<Spacer y={4} />

Expand Down
Loading