diff options
author | Fabio Berger <me@fabioberger.com> | 2018-08-24 01:12:39 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2018-08-24 01:12:39 +0800 |
commit | 6e27324a341801e1a2d8d6989d749dfe021ae39b (patch) | |
tree | 32b2e1d93958905f7e4d0529e4fbead4206275ab /packages/react-docs-example/ts/docs.tsx | |
parent | b013cf2e145825a9e250c61bc77825384b2af69e (diff) | |
parent | 8eb4b6f91791313dc02865a9dd3324cce646d537 (diff) | |
download | dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.gz dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.bz2 dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.lz dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.xz dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.tar.zst dexon-sol-tools-6e27324a341801e1a2d8d6989d749dfe021ae39b.zip |
Merge pull request #924 from 0xProject/wrap-typedoc
Improved Docs & Removed monorepo-scripts from packages
Diffstat (limited to 'packages/react-docs-example/ts/docs.tsx')
-rw-r--r-- | packages/react-docs-example/ts/docs.tsx | 123 |
1 files changed, 0 insertions, 123 deletions
diff --git a/packages/react-docs-example/ts/docs.tsx b/packages/react-docs-example/ts/docs.tsx deleted file mode 100644 index bb605806f..000000000 --- a/packages/react-docs-example/ts/docs.tsx +++ /dev/null @@ -1,123 +0,0 @@ -import * as React from 'react'; - -import { - constants, - DocAgnosticFormat, - DocsInfo, - DocsInfoConfig, - Documentation, - SupportedDocJson, - TypeDocNode, -} from '@0xproject/react-docs'; - -import * as v0TypeDocJson from './json/0.1.12.json'; -import * as v2TypeDocJson from './json/0.2.0.json'; - -// tslint:disable-next-line:no-implicit-dependencies no-var-requires -const IntroMarkdownV1 = require('md/introduction'); - -const docSections = { - introduction: 'introduction', - web3Wrapper: 'web3Wrapper', - types: constants.TYPES_SECTION_NAME, -}; - -const docsInfoConfig: DocsInfoConfig = { - id: 'web3Wrapper', - type: SupportedDocJson.TypeDoc, - displayName: 'Web3 Wrapper', - packageUrl: 'https://github.com/0xProject/0x-monorepo', - menu: { - introduction: [docSections.introduction], - web3Wrapper: [docSections.web3Wrapper], - types: [docSections.types], - }, - sectionNameToMarkdownByVersion: { - '0.0.1': { - [docSections.introduction]: IntroMarkdownV1, - }, - }, - sectionNameToModulePath: { - [docSections.web3Wrapper]: ['"web3-wrapper/src/index"'], - [docSections.types]: ['"types/src/index"'], - }, - menuSubsectionToVersionWhenIntroduced: {}, - sections: docSections, - visibleConstructors: [docSections.web3Wrapper], - typeConfigs: { - // Note: This needs to be kept in sync with the types exported in index.ts. Unfortunately there is - // currently no way to extract the re-exported types from index.ts via TypeDoc :( - publicTypes: [ - 'TxData', - 'TransactionReceipt', - 'RawLogEntry', - 'BlockParam', - 'ContractAbi', - 'FilterObject', - 'LogEntry', - 'BlockWithoutTransactionData', - 'CallData', - 'LogEntryEvent', - ], - typeNameToExternalLink: { - Web3: 'https://github.com/ethereum/wiki/wiki/JavaScript-API', - Provider: 'https://github.com/0xProject/web3-typescript-typings/blob/f5bcb96/index.d.ts#L150', - BigNumber: 'http://mikemcl.github.io/bignumber.js', - }, - typeNameToPrefix: { - Provider: 'Web3', - }, - typeNameToDocSection: { - Web3Wrapper: docSections.web3Wrapper, - }, - }, -}; -const docsInfo = new DocsInfo(docsInfoConfig); - -const availableVersions = ['0.1.12', '0.2.0']; -const versionToDocJSON: { [semver: string]: object } = { - [availableVersions[0]]: v0TypeDocJson, - [availableVersions[1]]: v2TypeDocJson, -}; - -export interface DocsProps {} - -export interface DocsState { - selectedVersion: string; - docAgnosticFormat?: DocAgnosticFormat; -} - -export class Docs extends React.Component<DocsProps, DocsState> { - constructor(props: DocsProps) { - super(props); - this.state = { - selectedVersion: availableVersions[1], - docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(v2TypeDocJson), - }; - } - public render(): React.ReactNode { - return ( - <Documentation - selectedVersion={this.state.selectedVersion} - availableVersions={availableVersions} - docsInfo={docsInfo} - docAgnosticFormat={this.state.docAgnosticFormat} - sourceUrl={this._getSourceUrl()} - onVersionSelected={this._onVersionSelected.bind(this)} - /> - ); - } - private _onVersionSelected(semver: string): void { - const selectedDocJSON = versionToDocJSON[semver]; - this.setState({ - selectedVersion: semver, - docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(selectedDocJSON as TypeDocNode), - }); - } - private _getSourceUrl(): string { - const sourceUrl = `${docsInfoConfig.packageUrl}/blob/@0xproject/web3-wrapper@${ - this.state.selectedVersion - }/packages`; - return sourceUrl; - } -} |