Skip to content

Commit

Permalink
docs: fix incorrect usage in Server Action in a Client Component exam…
Browse files Browse the repository at this point in the history
…ple (#68965)

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->

## What?

This PR fixes an incorrect usage of the `Button` component in the client
component example. The example mistakenly used a `Button` component
without importing or defining it properly, whereas the intent was to use
the native HTML `button` element.

## Why?

The original example incorrectly suggested that a custom `Button`
component was being used. However, the intent was likely to demonstrate
the usage of the native `button` element with an `onClick` handler to
trigger a Server Action. The existing code could lead to confusion, as
it implied the existence of a custom component named `Button` without
any clear definition or `import`, which would also result in a recursive
component reference issue.

## How?

This fix ensures that the example clearly demonstrates the intended use
of the native button element with an `onClick` handler, aligning with
best practices and avoiding potential errors or misunderstandings in
component usage.

Co-authored-by: JJ Kasper <jj@jjsweb.site>
  • Loading branch information
liby and ijjk authored Sep 12, 2024
1 parent 0cda862 commit 7bbc782
Showing 1 changed file with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export async function create() {}
import { create } from '@/app/actions'

export function Button() {
return <Button onClick={create} />
return <button onClick={create}>Create</button>
}
```

Expand All @@ -76,7 +76,7 @@ export function Button() {
import { create } from '@/app/actions'

export function Button() {
return <Button onClick={create} />
return <button onClick={create}>Create</button>
}
```

Expand Down

0 comments on commit 7bbc782

Please sign in to comment.