aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/example/ts/docs.tsx
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-07 20:57:17 +0800
committerFabio Berger <me@fabioberger.com>2018-03-07 20:57:17 +0800
commite31309f213e9b900225b077cb27792958ba1ad5d (patch)
tree9e60b84c0ac089b0c203051ef2de3771963864b6 /packages/react-docs/example/ts/docs.tsx
parent6f8a70834b72d678cd9d171d7bb0a3a2cfb4134d (diff)
downloaddexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar.gz
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar.bz2
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar.lz
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar.xz
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.tar.zst
dexon-sol-tools-e31309f213e9b900225b077cb27792958ba1ad5d.zip
Allow user to change versions in demo example
Diffstat (limited to 'packages/react-docs/example/ts/docs.tsx')
-rw-r--r--packages/react-docs/example/ts/docs.tsx93
1 files changed, 93 insertions, 0 deletions
diff --git a/packages/react-docs/example/ts/docs.tsx b/packages/react-docs/example/ts/docs.tsx
new file mode 100644
index 000000000..98cd5b355
--- /dev/null
+++ b/packages/react-docs/example/ts/docs.tsx
@@ -0,0 +1,93 @@
+import * as _ from 'lodash';
+import * as React from 'react';
+
+import { Documentation } from '../../src/ts/components/documentation';
+import { DocsInfo } from '../../src/ts/docs_info';
+import { DocAgnosticFormat, DocsInfoConfig, SupportedDocJson, TypeDocNode } from '../../src/ts/types';
+
+import * as v1TypeDocJson from './json/0.1.12.json';
+import * as v2TypeDocJson from './json/0.2.0.json';
+
+/* tslint:disable:no-var-requires */
+const IntroMarkdown = require('md/introduction');
+/* tslint:enable:no-var-requires */
+
+const docSections = {
+ introduction: 'introduction',
+ web3Wrapper: 'web3Wrapper',
+};
+
+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],
+ },
+ sectionNameToMarkdown: {
+ [docSections.introduction]: IntroMarkdown,
+ },
+ // 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'],
+ sectionNameToModulePath: {
+ [docSections.web3Wrapper]: ['"index"'],
+ },
+ menuSubsectionToVersionWhenIntroduced: {},
+ sections: docSections,
+ visibleConstructors: [docSections.web3Wrapper],
+};
+const docsInfo = new DocsInfo(docsInfoConfig);
+
+const availableVersions = ['0.1.12', '0.2.0'];
+const versionToDocJSON: { [semver: string]: object } = {
+ '0.1.12': v1TypeDocJson,
+ '0.2.0': v2TypeDocJson,
+};
+
+export interface DocsProps {}
+
+interface DocsState {
+ selectedVersion: string;
+ docAgnosticFormat?: DocAgnosticFormat;
+}
+
+export class Docs extends React.Component<DocsProps, DocsState> {
+ constructor(props: DocsProps) {
+ super(props);
+ this.state = {
+ selectedVersion: '0.2.0',
+ docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(v1TypeDocJson),
+ };
+ }
+ public render() {
+ const menuSubsectionsBySection = _.isUndefined(this.state.docAgnosticFormat)
+ ? {}
+ : docsInfo.getMenuSubsectionsBySection(this.state.docAgnosticFormat);
+ 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) {
+ const selectedDocJSON = versionToDocJSON[semver];
+ this.setState({
+ selectedVersion: semver,
+ docAgnosticFormat: docsInfo.convertToDocAgnosticFormat(selectedDocJSON as TypeDocNode),
+ });
+ }
+ private _getSourceUrl() {
+ const sourceUrl = `${docsInfoConfig.packageUrl}/blob/@0xproject/web3-wrapper%40${
+ this.state.selectedVersion
+ }/packages/web3-wrapper`;
+ return sourceUrl;
+ }
+}