docz
- Version 2.4.0
- Published
- 93.3 kB
- 18 dependencies
- MIT license
Install
npm i docz
yarn add docz
pnpm add docz
Overview
It's has never been so easy to documents your things!
Index
Variables
Functions
Interfaces
Type Aliases
Variables
variable ComponentsProvider
const ComponentsProvider: FC<ComponentsProviderProps>;
variable doczState
const doczState: State<DoczState>;
variable Playground
const Playground: FC<PlaygroundProps>;
variable Props
const Props: FC<PropsProps>;
Functions
function theme
theme: ( themeConfig: ThemeConfig, transform?: TransformFn) => (WrappedComponent: CT) => CT<ThemeProps>;
function useComponentProps
useComponentProps: ({ componentName, fileName }: UseComponentPropsParams) => any;
function useComponents
useComponents: () => ComponentsMap;
function useConfig
useConfig: () => UseConfigObj;
function useCurrentDoc
useCurrentDoc: () => any;
function useDataServer
useDataServer: (url: string | undefined) => void;
function useDocs
useDocs: () => Entry[] | null;
function useMenus
useMenus: (opts?: UseMenusParams | undefined) => MenuItem[] | null;
function usePrevious
usePrevious: (value: any, defaultValue?: any) => any;
function useWindowSize
useWindowSize: ( throttleMs?: number, _initialWidth?: number, initialHeight?: number) => { innerHeight: number; innerWidth: number; outerHeight: number; outerWidth: number;};
Interfaces
interface ComponentsMap
interface ComponentsMap {}
property layout
layout?: CT<LayoutProps>;
property notFound
notFound?: CT;
property playground
playground?: CT<PlaygroundProps>;
index signature
[key: string]: any;
interface ComponentsProviderProps
interface ComponentsProviderProps {}
property components
components: ComponentsMap;
interface Entry
interface Entry {}
interface LayoutProps
interface LayoutProps {}
property doc
doc: Entry;
index signature
[key: string]: any;
interface MenuItem
interface MenuItem {}
interface PlaygroundProps
interface PlaygroundProps {}
interface PropsComponentProps
interface PropsComponentProps {}
property isRaw
isRaw?: boolean;
property isToggle
isToggle?: boolean;
property of
of: ComponentWithDocGenInfo;
property props
props: Record<string, Prop>;
property title
title?: Node;
method getPropType
getPropType: (prop: Prop) => string;
index signature
[key: string]: any;
interface UseConfigObj
interface UseConfigObj extends Config {}
property themeConfig
themeConfig: ThemeConfig;
Type Aliases
type ThemeConfig
type ThemeConfig = Record<string, any>;
Package Files (14)
- dist/components/Playground.d.ts
- dist/components/Props.d.ts
- dist/hooks/useComponentProps.d.ts
- dist/hooks/useComponents.d.ts
- dist/hooks/useConfig.d.ts
- dist/hooks/useCurrentDoc.d.ts
- dist/hooks/useDataServer.d.ts
- dist/hooks/useDocs.d.ts
- dist/hooks/useMenus.d.ts
- dist/hooks/usePrevious.d.ts
- dist/hooks/useWindowSize.d.ts
- dist/index.d.ts
- dist/state.d.ts
- dist/theme.d.ts
Dependencies (18)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (2)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/docz
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/docz)
- HTML<a href="https://www.jsdocs.io/package/docz"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 2524 ms. - Missing or incorrect documentation? Open an issue for this package.