From 0b1ba9f9971bea9003dfb30fca535c17ce62ad08 Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Tue, 6 Mar 2018 16:31:55 +0100
Subject: Move Documentation to the `@0xproject/react-docs` package
---
.../react-docs/src/ts/components/interface.tsx | 63 ++++++++++++++++++++++
1 file changed, 63 insertions(+)
create mode 100644 packages/react-docs/src/ts/components/interface.tsx
(limited to 'packages/react-docs/src/ts/components/interface.tsx')
diff --git a/packages/react-docs/src/ts/components/interface.tsx b/packages/react-docs/src/ts/components/interface.tsx
new file mode 100644
index 000000000..1c99495d7
--- /dev/null
+++ b/packages/react-docs/src/ts/components/interface.tsx
@@ -0,0 +1,63 @@
+import * as _ from 'lodash';
+import * as React from 'react';
+
+import { CustomType, TypeDocTypes } from '../types';
+
+import { DocsInfo } from './docs_info';
+import { MethodSignature } from './method_signature';
+import { Type } from './type';
+
+export interface InterfaceProps {
+ type: CustomType;
+ sectionName: string;
+ docsInfo: DocsInfo;
+}
+
+export function Interface(props: InterfaceProps) {
+ const type = props.type;
+ const properties = _.map(type.children, property => {
+ return (
+ <span key={`property-${property.name}-${property.type}-${type.name}`}>
+ {property.name}:{' '}
+ {property.type.typeDocType !== TypeDocTypes.Reflection ? (
+ <Type type={property.type} sectionName={props.sectionName} docsInfo={props.docsInfo} />
+ ) : (
+ <MethodSignature
+ method={property.type.method}
+ sectionName={props.sectionName}
+ shouldHideMethodName={true}
+ shouldUseArrowSyntax={true}
+ docsInfo={props.docsInfo}
+ />
+ )},
+ </span>
+ );
+ });
+ const hasIndexSignature = !_.isUndefined(type.indexSignature);
+ if (hasIndexSignature) {
+ const is = type.indexSignature;
+ const param = (
+ <span key={`indexSigParams-${is.keyName}-${is.keyType}-${type.name}`}>
+ {is.keyName}: <Type type={is.keyType} sectionName={props.sectionName} docsInfo={props.docsInfo} />
+ </span>
+ );
+ properties.push(
+ <span key={`indexSignature-${type.name}-${is.keyType.name}`}>
+ [{param}]: {is.valueName},
+ </span>,
+ );
+ }
+ const propertyList = _.reduce(properties, (prev: React.ReactNode, curr: React.ReactNode) => {
+ return [prev, '\n\t', curr];
+ });
+ return (
+ <span>
+ {`{`}
+ <br />
+ {'\t'}
+ {propertyList}
+ <br />
+ {`}`}
+ </span>
+ );
+}
--
cgit
From 60d95475ebcfc868e54f90350fcca09e45b976ff Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Tue, 6 Mar 2018 16:45:25 +0100
Subject: Move DocsInfo out of the components folder
---
packages/react-docs/src/ts/components/interface.tsx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'packages/react-docs/src/ts/components/interface.tsx')
diff --git a/packages/react-docs/src/ts/components/interface.tsx b/packages/react-docs/src/ts/components/interface.tsx
index 1c99495d7..92883089a 100644
--- a/packages/react-docs/src/ts/components/interface.tsx
+++ b/packages/react-docs/src/ts/components/interface.tsx
@@ -3,7 +3,7 @@ import * as React from 'react';
import { CustomType, TypeDocTypes } from '../types';
-import { DocsInfo } from './docs_info';
+import { DocsInfo } from '../docs_info';
import { MethodSignature } from './method_signature';
import { Type } from './type';
--
cgit
From e88eba18772015b07c9ae305260c12f1cdf69e8c Mon Sep 17 00:00:00 2001
From: Fabio Berger <me@fabioberger.com>
Date: Tue, 6 Mar 2018 20:55:57 +0100
Subject: Fix tslint errors
---
packages/react-docs/src/ts/components/interface.tsx | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
(limited to 'packages/react-docs/src/ts/components/interface.tsx')
diff --git a/packages/react-docs/src/ts/components/interface.tsx b/packages/react-docs/src/ts/components/interface.tsx
index 92883089a..01f4942ef 100644
--- a/packages/react-docs/src/ts/components/interface.tsx
+++ b/packages/react-docs/src/ts/components/interface.tsx
@@ -1,9 +1,9 @@
import * as _ from 'lodash';
import * as React from 'react';
+import { DocsInfo } from '../docs_info';
import { CustomType, TypeDocTypes } from '../types';
-import { DocsInfo } from '../docs_info';
import { MethodSignature } from './method_signature';
import { Type } from './type';
--
cgit