docs: create docs workspace (#5174)
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
import { HookTable } from "@/components/hook-table"
|
||||
import { HookDataMap } from "@/types/hooks"
|
||||
|
||||
const PromptPropsValues: HookDataMap = [
|
||||
{
|
||||
value: "title",
|
||||
type: "string",
|
||||
},
|
||||
{
|
||||
value: "description",
|
||||
type: "string",
|
||||
},
|
||||
{
|
||||
value: "verificationText",
|
||||
type: "string",
|
||||
description: "Text the user has to input in order to confirm the action",
|
||||
},
|
||||
{
|
||||
value: "cancelText",
|
||||
type: "string",
|
||||
description: `Label for the Cancel button. Defaults to "Cancel".`,
|
||||
},
|
||||
{
|
||||
value: "confirmText",
|
||||
type: "string",
|
||||
description: `Label for the Confirm button. Defaults to "Confirm".`,
|
||||
},
|
||||
]
|
||||
|
||||
const Props = () => {
|
||||
return <HookTable props={PromptPropsValues} />
|
||||
}
|
||||
|
||||
export default Props
|
||||
@@ -0,0 +1,44 @@
|
||||
import { HookTable } from "@/components/hook-table"
|
||||
import { HookDataMap } from "@/types/hooks"
|
||||
|
||||
const ToasterToastValues: HookDataMap = [
|
||||
{
|
||||
value: "id",
|
||||
type: "string",
|
||||
},
|
||||
{
|
||||
value: "title",
|
||||
type: "ReactNode",
|
||||
},
|
||||
{
|
||||
value: "description",
|
||||
type: "ReactNode",
|
||||
},
|
||||
{
|
||||
value: "variant",
|
||||
type: {
|
||||
type: "enum",
|
||||
values: ["info", "success", "warning", "error", "loading"],
|
||||
},
|
||||
description: `Defaults to "info"`,
|
||||
},
|
||||
{
|
||||
value: "action",
|
||||
type: {
|
||||
type: "object",
|
||||
name: "ToastActionElement",
|
||||
shape:
|
||||
"{\n label: string\n altText: string\n onClick: () => void | Promise<void>\n}",
|
||||
},
|
||||
},
|
||||
{
|
||||
value: "disableDismiss",
|
||||
type: "boolean",
|
||||
},
|
||||
]
|
||||
|
||||
const Props = () => {
|
||||
return <HookTable props={ToasterToastValues} />
|
||||
}
|
||||
|
||||
export default Props
|
||||
@@ -0,0 +1,19 @@
|
||||
import { HookTable } from "@/components/hook-table"
|
||||
import { HookDataMap } from "@/types/hooks"
|
||||
|
||||
const useToastValues: HookDataMap = [
|
||||
{
|
||||
value: "dialog",
|
||||
type: {
|
||||
type: "function",
|
||||
signature: `async (props: PromptProps): Promise<boolean>`,
|
||||
},
|
||||
description: "Async function used to display a new confirmation dialog.",
|
||||
},
|
||||
]
|
||||
|
||||
const Props = () => {
|
||||
return <HookTable props={useToastValues} />
|
||||
}
|
||||
|
||||
export default Props
|
||||
@@ -0,0 +1,34 @@
|
||||
import { HookTable } from "@/components/hook-table"
|
||||
import { HookDataMap } from "@/types/hooks"
|
||||
|
||||
const useToastValues: HookDataMap = [
|
||||
{
|
||||
value: "toast",
|
||||
type: {
|
||||
type: "function",
|
||||
signature: `(toast: Omit<ToasterToast, "id">) => {\n id: string,\n dismiss: () => void,\n update: (toast: ToasterToast) => void\n}`,
|
||||
},
|
||||
description:
|
||||
"Function used to display new toasts. For the toast options, please check the ToasterToast reference below.",
|
||||
},
|
||||
{
|
||||
value: "dismiss",
|
||||
type: {
|
||||
type: "function",
|
||||
signature: "(toastId?: string) => void",
|
||||
},
|
||||
description: "Function used to hide a toast based on its id.",
|
||||
},
|
||||
{
|
||||
value: "toasts",
|
||||
type: "ToasterToast[]",
|
||||
description:
|
||||
"All the toasts that have been pushed to the context this hook was invoked in.",
|
||||
},
|
||||
]
|
||||
|
||||
const Props = () => {
|
||||
return <HookTable props={useToastValues} />
|
||||
}
|
||||
|
||||
export default Props
|
||||
@@ -0,0 +1,20 @@
|
||||
import { HookTable } from "@/components/hook-table"
|
||||
import { HookDataMap } from "@/types/hooks"
|
||||
|
||||
const useToggleStateValuesArray: HookDataMap = [
|
||||
{
|
||||
value: "state",
|
||||
type: {
|
||||
type: "object",
|
||||
name: "StateData",
|
||||
shape:
|
||||
"[\n state: boolean,\n open: () => void,\n close: () => void,\n toggle: () => void\n]",
|
||||
},
|
||||
},
|
||||
]
|
||||
|
||||
const Props = () => {
|
||||
return <HookTable props={useToggleStateValuesArray} />
|
||||
}
|
||||
|
||||
export default Props
|
||||
Reference in New Issue
Block a user