docs: generate medusa-react reference (#6004)

* add new plugin for better organization

* added handling in theme for mutations and query types

* added tsdoc to hooks

* added tsdocs to utility functions

* added tsdoc to providers

* generated reference

* general fixes for generated reference

* generated api reference specs + general fixes

* add missing import react

* split utilities into different directories

* added overview page

* added link to customer authentication section

* fix lint errors

* added changeset

* fix readme

* fixed build error

* added expand fields + other sections to overview

* updated what's new section

* general refactoring

* remove unnecessary query field

* fix links

* added ignoreApi option
This commit is contained in:
Shahed Nasser
2024-01-05 17:03:38 +02:00
committed by GitHub
parent 6fc6a9de6a
commit 7d650771d1
2811 changed files with 231856 additions and 455063 deletions
@@ -283,17 +283,24 @@ You can update a users details in their profile by sending a request to the [
```tsx
import {
useAdminDeleteSession,
useAdminUpdateUser,
} from "medusa-react"
const Profile = () => {
type Props = {
userId: string
}
const Profile = ({ userId }: Props) => {
const updateUser = useAdminUpdateUser(userId)
// ...
const handleUpdate = () => {
const handleUpdate = (firstName: string) => {
updateUser.mutate({
first_name: "Marcellus",
first_name: firstName,
}, {
onSuccess: ({ user }) => {
console.log(user.first_name)
}
})
}
@@ -384,9 +391,15 @@ You can request a password reset by sending a request to the [Request Password R
const requestPasswordReset = useAdminSendResetPasswordToken()
// ...
const handleResetPassword = () => {
const handleResetPassword = (
email: string
) => {
requestPasswordReset.mutate({
email: "user@example.com",
email
}, {
onSuccess: () => {
// successful
}
})
}
@@ -463,10 +476,17 @@ You can reset the password by sending a request to the [Reset Password API Route
const resetPassword = useAdminResetPassword()
// ...
const handleResetPassword = () => {
const handleResetPassword = (
token: string,
password: string
) => {
resetPassword.mutate({
token: "supersecrettoken",
password: "supersecret",
token,
password,
}, {
onSuccess: ({ user }) => {
console.log(user.id)
}
})
}