-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into remove-colon-callout-title
- Loading branch information
Showing
2 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
src/routes/solid-router/reference/data-apis/use-action.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: useAction | ||
--- | ||
|
||
`useAction` allows an [`action`](/solid-router/reference/data-apis/action) to be invoked programmatically. | ||
|
||
```tsx | ||
import { useAction } from "@solidjs/router"; | ||
import { updateNameAction } from "./actions"; | ||
|
||
const updateName = useAction(updateNameAction); | ||
|
||
const result = updateName("John Wick"); | ||
``` | ||
|
||
<Callout type="info" title="Note"> | ||
`useAction` requires client-side JavaScript and is not progressively | ||
enhanceable. | ||
</Callout> | ||
|
||
## Parameters | ||
|
||
- `action`: The action to be invoked. | ||
|
||
## Returns | ||
|
||
`useAction` returns a function that invokes the action. | ||
It shares the same signature as the action itself. |