@uidu/docs
- Version 0.11.4
- Published
- 67.4 kB
- 13 dependencies
- ISC license
Install
npm i @uidu/docs
yarn add @uidu/docs
pnpm add @uidu/docs
Overview
Utilities for building documentation
Index
Variables
variable md
const md: any;
Functions
function code
code: (sources: any, ...substitutions: any[]) => React.JSX.Element;
function Props
Props: (props: any) => React.JSX.Element;
function replaceSrc
replaceSrc: (content: any, name: any) => any;
function Table
Table: ({ children }: { children: any }) => React.JSX.Element;
function Td
Td: ({ children }: { children: any }) => React.JSX.Element;
function Th
Th: ({ children }: { children: any }) => React.JSX.Element;
function Tr
Tr: ({ children, isOdd }: { children: any; isOdd: any }) => React.JSX.Element;
Classes
class Example
class Example extends React.Component<Props, State> {}
property defaultProps
static defaultProps: { language: string };
property onError
onError: (error: Error, info: any) => void;
property state
state: { isSourceVisible: boolean; isHover: boolean };
property toggleElement
toggleElement: any;
property toggleSource
toggleSource: () => void;
method render
render: () => React.JSX.Element;
Package Files (7)
Dependencies (13)
Dev Dependencies (2)
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/@uidu/docs
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@uidu/docs)
- HTML<a href="https://www.jsdocs.io/package/@uidu/docs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3629 ms. - Missing or incorrect documentation? Open an issue for this package.