crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor Home so that Dev section chrome is reusable across pages

Browse Source
This commit is contained in:
Fabio Berger
2018-10-12 15:54:44 +02:00
parent dcdc411ab7
commit de20ef1a49
14 changed files with 780 additions and 854 deletions
Download Patch File Download Diff File Expand all files Collapse all files

120
packages/react-docs/src/components/documentation.tsx → packages/react-docs/src/components/doc_reference.tsx
View File

@@ -4,10 +4,8 @@ import {
EtherscanLinkSuffixes,
Link,
MarkdownSection,
NestedSidebarMenu,
Networks,
SectionHeader,
Styles,
utils as sharedUtils,
} from '@0xproject/react-shared';
import {
@@ -21,7 +19,6 @@ import {
TypescriptMethod,
} from '@0xproject/types';
import * as _ from 'lodash';
import CircularProgress from 'material-ui/CircularProgress';
import * as React from 'react';
import * as semver from 'semver';
@@ -43,26 +40,20 @@ const networkNameToColor: { [network: string]: string } = {
[Networks.Rinkeby]: colors.darkYellow,
};
export interface DocumentationProps {
export interface DocReferenceProps {
selectedVersion: string;
availableVersions: string[];
docsInfo: DocsInfo;
sourceUrl: string;
onVersionSelected: (semver: string) => void;
docAgnosticFormat?: DocAgnosticFormat;
sidebarHeader?: React.ReactNode;
topBarHeight?: number;
}
export interface DocumentationState {
export interface DocReferenceState {
isHoveringSidebar: boolean;
}
export class Documentation extends React.Component<DocumentationProps, DocumentationState> {
public static defaultProps: Partial<DocumentationProps> = {
topBarHeight: 0,
};
constructor(props: DocumentationProps) {
export class DocReference extends React.Component<DocReferenceProps, DocReferenceState> {
constructor(props: DocReferenceProps) {
super(props);
this.state = {
isHoveringSidebar: false,
@@ -74,112 +65,25 @@ export class Documentation extends React.Component<DocumentationProps, Documenta
public componentWillUnmount(): void {
window.removeEventListener('hashchange', this._onHashChanged.bind(this), false);
}
public componentDidUpdate(prevProps: DocumentationProps, _prevState: DocumentationState): void {
public componentDidUpdate(prevProps: DocReferenceProps, _prevState: DocReferenceState): void {
if (!_.isEqual(prevProps.docAgnosticFormat, this.props.docAgnosticFormat)) {
const hash = window.location.hash.slice(1);
sharedUtils.scrollToHash(hash, sharedConstants.SCROLL_CONTAINER_ID);
}
}
public render(): React.ReactNode {
const styles: Styles = {
mainContainers: {
position: 'absolute',
top: 1,
left: 0,
bottom: 0,
right: 0,
overflowX: 'hidden',
overflowY: 'scroll',
minHeight: `calc(100vh - ${this.props.topBarHeight}px)`,
WebkitOverflowScrolling: 'touch',
},
menuContainer: {
borderColor: colors.grey300,
maxWidth: 330,
marginLeft: 20,
},
};
const sectionNameToLinks = this.props.docsInfo.getSectionNameToLinks();
const subsectionNameToLinks = this.props.docsInfo.getSubsectionNameToLinks(this.props.docAgnosticFormat);
return (
<div>
{_.isUndefined(this.props.docAgnosticFormat) ? (
this._renderLoading(styles.mainContainers)
) : (
<div style={{ width: '100%', height: '100%', backgroundColor: colors.gray40 }}>
<div
className="mx-auto max-width-4 flex"
style={{ color: colors.grey800, height: `calc(100vh - ${this.props.topBarHeight}px)` }}
>
<div
className="relative sm-hide xs-hide"
style={{ width: '36%', height: `calc(100vh - ${this.props.topBarHeight}px)` }}
>
<div
className="border-right absolute"
style={{
...styles.menuContainer,
...styles.mainContainers,
height: `calc(100vh - ${this.props.topBarHeight}px)`,
overflow: this.state.isHoveringSidebar ? 'auto' : 'hidden',
}}
onMouseEnter={this._onSidebarHover.bind(this)}
onMouseLeave={this._onSidebarHoverOff.bind(this)}
>
<NestedSidebarMenu
selectedVersion={this.props.selectedVersion}
versions={this.props.availableVersions}
sidebarHeader={this.props.sidebarHeader}
sectionNameToLinks={sectionNameToLinks}
subsectionNameToLinks={subsectionNameToLinks}
onVersionSelected={this.props.onVersionSelected}
/>
</div>
</div>
<div
className="relative col lg-col-9 md-col-9 sm-col-12 col-12"
style={{ backgroundColor: colors.white }}
>
<div
id={sharedConstants.SCROLL_CONTAINER_ID}
style={styles.mainContainers}
className="absolute px1"
>
<div id={sharedConstants.SCROLL_TOP_ID} />
{this._renderDocumentation()}
</div>
</div>
</div>
</div>
)}
</div>
);
}
private _renderLoading(mainContainersStyles: React.CSSProperties): React.ReactNode {
return (
<div className="col col-12" style={mainContainersStyles}>
<div
className="relative sm-px2 sm-pt2 sm-m1"
style={{ height: 122, top: '50%', transform: 'translateY(-50%)' }}
>
<div className="center pb2">
<CircularProgress size={40} thickness={5} />
</div>
<div className="center pt2" style={{ paddingBottom: 11 }}>
Loading documentation...
</div>
</div>
</div>
);
}
private _renderDocumentation(): React.ReactNode {
const subMenus = _.values(this.props.docsInfo.menu);
const subMenus = _.values(this.props.docsInfo.markdownMenu);
const orderedSectionNames = _.flatten(subMenus);
const typeDefinitionByName = this.props.docsInfo.getTypeDefinitionsByName(this.props.docAgnosticFormat);
const renderedSections = _.map(orderedSectionNames, this._renderSection.bind(this, typeDefinitionByName));
return renderedSections;
return (
<div>
<div id={sharedConstants.SCROLL_TOP_ID} />
{renderedSections}
</div>
);
}
private _renderSection(typeDefinitionByName: TypeDefinitionByName, sectionName: string): React.ReactNode {
const markdownVersions = _.keys(this.props.docsInfo.sectionNameToMarkdownByVersion);

59
packages/react-docs/src/docs_info.ts
View File

@@ -17,7 +17,7 @@ export class DocsInfo {
public displayName: string;
public packageName: string;
public packageUrl: string;
public menu: DocsMenu;
public markdownMenu: DocsMenu;
public typeSectionName: string;
public sections: SectionsMap;
public sectionNameToMarkdownByVersion: SectionNameToMarkdownByVersion;
@@ -25,7 +25,7 @@ export class DocsInfo {
constructor(config: DocsInfoConfig) {
this.id = config.id;
this.type = config.type;
this.menu = config.markdownMenu;
this.markdownMenu = config.markdownMenu;
this.displayName = config.displayName;
this.packageName = config.packageName;
this.packageUrl = config.packageUrl;
@@ -34,10 +34,31 @@ export class DocsInfo {
this.sectionNameToMarkdownByVersion = config.sectionNameToMarkdownByVersion;
this.contractsByVersionByNetworkId = config.contractsByVersionByNetworkId;
}
public getSubsectionNameToLinks(docAgnosticFormat?: DocAgnosticFormat): ObjectMap<ALink[]> {
const subsectionNameToLinks: ObjectMap<ALink[]> = {};
public getTypeDefinitionsByName(docAgnosticFormat: DocAgnosticFormat): { [name: string]: TypeDefinitionByName } {
if (_.isUndefined(docAgnosticFormat[this.typeSectionName])) {
return {};
}
const section = docAgnosticFormat[this.typeSectionName];
const typeDefinitionByName = _.keyBy(section.types, 'name') as any;
return typeDefinitionByName;
}
public getSectionNameToLinks(docAgnosticFormat: DocAgnosticFormat): ObjectMap<ALink[]> {
const sectionNameToLinks: ObjectMap<ALink[]> = {};
_.each(this.markdownMenu, (linkTitles, sectionName) => {
sectionNameToLinks[sectionName] = [];
_.each(linkTitles, linkTitle => {
const to = sharedUtils.getIdFromName(linkTitle);
const links = sectionNameToLinks[sectionName];
links.push({
title: linkTitle,
to,
});
});
});
if (_.isUndefined(docAgnosticFormat)) {
return subsectionNameToLinks;
return sectionNameToLinks;
}
const docSections = _.keys(this.sections);
@@ -64,7 +85,7 @@ export class DocsInfo {
title: typeName,
};
});
subsectionNameToLinks[sectionName] = typeLinks;
sectionNameToLinks[sectionName] = typeLinks;
} else if (isExportedFunctionSection) {
// Noop so that we don't have the method listed underneath itself.
} else {
@@ -88,33 +109,9 @@ export class DocsInfo {
};
});
subsectionNameToLinks[sectionName] = links;
sectionNameToLinks[sectionName] = links;
}
});
return subsectionNameToLinks;
}
public getTypeDefinitionsByName(docAgnosticFormat: DocAgnosticFormat): { [name: string]: TypeDefinitionByName } {
if (_.isUndefined(docAgnosticFormat[this.typeSectionName])) {
return {};
}
const section = docAgnosticFormat[this.typeSectionName];
const typeDefinitionByName = _.keyBy(section.types, 'name') as any;
return typeDefinitionByName;
}
public getSectionNameToLinks(): ObjectMap<ALink[]> {
const sectionNameToLinks: ObjectMap<ALink[]> = {};
_.each(this.menu, (linkTitles, sectionName) => {
sectionNameToLinks[sectionName] = [];
_.each(linkTitles, linkTitle => {
const to = sharedUtils.getIdFromName(linkTitle);
const links = sectionNameToLinks[sectionName];
links.push({
title: linkTitle,
to,
});
});
});
return sectionNameToLinks;
}
}

2
packages/react-docs/src/index.ts
View File

@@ -5,7 +5,7 @@ export { DocAgnosticFormat, GeneratedDocJson } from '@0xproject/types';
export { Badge } from './components/badge';
export { Comment } from './components/comment';
export { CustomEnum } from './components/custom_enum';
export { Documentation } from './components/documentation';
export { DocReference } from './components/doc_reference';
export { Enum } from './components/enum';
export { EventDefinition } from './components/event_definition';
export { Interface } from './components/interface';

10
packages/react-docs/src/utils/typedoc_utils.ts
View File

@@ -95,7 +95,9 @@ export class TypeDocUtils {
if (!_.isEmpty(this._externalExportToLink)) {
this._docsInfo.sections[constants.EXTERNAL_EXPORTS_SECTION_NAME] = constants.EXTERNAL_EXPORTS_SECTION_NAME;
this._docsInfo.menu[constants.EXTERNAL_EXPORTS_SECTION_NAME] = [constants.EXTERNAL_EXPORTS_SECTION_NAME];
this._docsInfo.markdownMenu[constants.EXTERNAL_EXPORTS_SECTION_NAME] = [
constants.EXTERNAL_EXPORTS_SECTION_NAME,
];
const docSection: DocSection = {
comment: 'This package also re-exports some third-party libraries for your convenience.',
constructors: [],
@@ -119,7 +121,7 @@ export class TypeDocUtils {
case KindString.ObjectLiteral: {
sectionName = child.name;
this._docsInfo.sections[sectionName] = sectionName;
this._docsInfo.menu[sectionName] = [sectionName];
this._docsInfo.markdownMenu[sectionName] = [sectionName];
const entities = child.children;
const commentObj = child.comment;
const sectionComment = !_.isUndefined(commentObj) ? commentObj.shortText : '';
@@ -136,7 +138,7 @@ export class TypeDocUtils {
case KindString.Function: {
sectionName = child.name;
this._docsInfo.sections[sectionName] = sectionName;
this._docsInfo.menu[sectionName] = [sectionName];
this._docsInfo.markdownMenu[sectionName] = [sectionName];
const entities = [child];
const commentObj = child.comment;
const SectionComment = !_.isUndefined(commentObj) ? commentObj.shortText : '';
@@ -158,7 +160,7 @@ export class TypeDocUtils {
});
if (!_.isEmpty(typeEntities)) {
this._docsInfo.sections[constants.TYPES_SECTION_NAME] = constants.TYPES_SECTION_NAME;
this._docsInfo.menu[constants.TYPES_SECTION_NAME] = [constants.TYPES_SECTION_NAME];
this._docsInfo.markdownMenu[constants.TYPES_SECTION_NAME] = [constants.TYPES_SECTION_NAME];
const docSection = this._convertEntitiesToDocSection(typeEntities, constants.TYPES_SECTION_NAME);
docAgnosticFormat[constants.TYPES_SECTION_NAME] = docSection;
}

38
packages/react-shared/src/components/nested_sidebar_menu.tsx
View File

@@ -12,7 +12,6 @@ import { VersionDropDown } from './version_drop_down';
export interface NestedSidebarMenuProps {
sectionNameToLinks: ObjectMap<ALink[]>;
subsectionNameToLinks?: ObjectMap<ALink[]>;
sidebarHeader?: React.ReactNode;
shouldDisplaySectionHeaders?: boolean;
onMenuItemClick?: () => void;
@@ -44,7 +43,6 @@ export class NestedSidebarMenu extends React.Component<NestedSidebarMenuProps, N
shouldDisplaySectionHeaders: true,
onMenuItemClick: _.noop.bind(_),
shouldReformatMenuItemNames: true,
subsectionNameToLinks: {},
};
public render(): React.ReactNode {
const navigation = _.map(this.props.sectionNameToLinks, (links: ALink[], sectionName: string) => {
@@ -108,47 +106,11 @@ export class NestedSidebarMenu extends React.Component<NestedSidebarMenuProps, N
</span>
</MenuItem>
</Link>
{this._renderMenuItemSubsections(link.title)}
</div>
);
});
return menuItems;
}
private _renderMenuItemSubsections(menuItemName: string): React.ReactNode {
if (
_.isUndefined(this.props.subsectionNameToLinks) ||
_.isUndefined(this.props.subsectionNameToLinks[menuItemName])
) {
return null;
}
return this._renderSubsectionLinks(menuItemName, this.props.subsectionNameToLinks[menuItemName]);
}
private _renderSubsectionLinks(menuItemName: string, links: ALink[]): React.ReactNode {
return (
<ul style={{ margin: 0, listStyleType: 'none', paddingLeft: 0 }} key={menuItemName}>
{_.map(links, link => {
const name = `${menuItemName}-${link.title}`;
return (
<li key={`menuSubsectionItem-${name}`}>
<Link to={link.to} shouldOpenInNewTab={link.shouldOpenInNewTab}>
<MenuItem
style={{ minHeight: 35 }}
innerDivStyle={{
paddingLeft: 16,
fontSize: 14,
lineHeight: '35px',
}}
onClick={this._onMenuItemClick.bind(this)}
>
{link.title}
</MenuItem>
</Link>
</li>
);
})}
</ul>
);
}
private _onMenuItemClick(): void {
if (!_.isUndefined(this.props.onMenuItemClick)) {
this.props.onMenuItemClick();

132
packages/website/ts/components/documentation/overview_content.tsx Normal file
View File

@@ -0,0 +1,132 @@
import { colors, Link, MarkdownLinkBlock, utils as sharedUtils } from '@0xproject/react-shared';
import { ObjectMap } from '@0xproject/types';
import * as _ from 'lodash';
import * as React from 'react';
import * as ReactMarkdown from 'react-markdown';
import { Element as ScrollElement } from 'react-scroll';
import { TutorialButton } from 'ts/components/documentation/tutorial_button';
import { Container } from 'ts/components/ui/container';
import { Text } from 'ts/components/ui/text';
import { Deco, Key, Package, TutorialInfo } from 'ts/types';
import { Translate } from 'ts/utils/translate';
export interface OverviewContentProps {
translate: Translate;
tutorials: TutorialInfo[];
categoryToPackages: ObjectMap<Package[]>;
}
export interface OverviewContentState {}
export class OverviewContent extends React.Component<OverviewContentProps, OverviewContentState> {
public render(): React.ReactNode {
return (
<Container>
{this._renderSectionTitle(this.props.translate.get(Key.StartBuildOn0x, Deco.Cap))}
<Container paddingTop="12px">
{this._renderSectionDescription(this.props.translate.get(Key.StartBuildOn0xDescription, Deco.Cap))}
<Container marginTop="36px">
{_.map(this.props.tutorials, tutorialInfo => (
<ScrollElement
name={sharedUtils.getIdFromName(
this.props.translate.get(tutorialInfo.link.title as Key, Deco.Cap),
)}
key={`tutorial-${tutorialInfo.link.title}`}
>
<TutorialButton translate={this.props.translate} tutorialInfo={tutorialInfo} />
</ScrollElement>
))}
</Container>
</Container>
<Container marginTop="32px" paddingBottom="100px">
{this._renderSectionTitle(this.props.translate.get(Key.LibrariesAndTools, Deco.CapWords))}
<Container paddingTop="12px">
{this._renderSectionDescription(
this.props.translate.get(Key.LibrariesAndToolsDescription, Deco.Cap),
)}
<Container marginTop="36px">
{_.map(this.props.categoryToPackages, (pkgs, category) =>
this._renderPackageCategory(category, pkgs),
)}
</Container>
</Container>
</Container>
</Container>
);
}
private _renderPackageCategory(category: string, pkgs: Package[]): React.ReactNode {
return (
<Container key={`category-${category}`}>
<Text fontSize="18px">{category}</Text>
<Container>{_.map(pkgs, pkg => this._renderPackage(pkg))}</Container>
</Container>
);
}
private _renderPackage(pkg: Package): React.ReactNode {
const id = sharedUtils.getIdFromName(pkg.link.title);
return (
<ScrollElement name={id} key={`package-${pkg.link.title}`}>
<Container className="pb2">
<Container width="100%" height="1px" backgroundColor={colors.grey300} marginTop="11px" />
<Container className="clearfix mt2 pt1">
<Container className="md-col lg-col md-col-4 lg-col-4">
<Link
to={pkg.link.to}
fontColor={colors.lightLinkBlue}
shouldOpenInNewTab={!!pkg.link.shouldOpenInNewTab}
>
<Text Tag="div" fontColor={colors.lightLinkBlue} fontWeight="bold">
{pkg.link.title}
</Text>
</Link>
</Container>
<Container className="md-col lg-col md-col-6 lg-col-6 sm-py2">
<Text fontColor={colors.grey700}>
<ReactMarkdown
source={pkg.description}
renderers={{
link: MarkdownLinkBlock,
paragraph: 'span',
}}
/>
</Text>
</Container>
<Container className="md-col lg-col md-col-2 lg-col-2 sm-pb2 relative">
<Container position="absolute" right="0px">
<Link
to={pkg.link.to}
fontColor={colors.lightLinkBlue}
shouldOpenInNewTab={!!pkg.link.shouldOpenInNewTab}
>
<Container className="flex">
<Container>{this.props.translate.get(Key.More, Deco.Cap)}</Container>
<Container paddingTop="1px" paddingLeft="6px">
<i
className="zmdi zmdi-chevron-right bold"
style={{ fontSize: 18, color: colors.lightLinkBlue }}
/>
</Container>
</Container>
</Link>
</Container>
</Container>
</Container>
</Container>
</ScrollElement>
);
}
private _renderSectionTitle(text: string): React.ReactNode {
return (
<Text fontColor={colors.projectsGrey} fontSize="30px" fontWeight="bold">
{text}
</Text>
);
}
private _renderSectionDescription(text: string): React.ReactNode {
return (
<Text fontColor={colors.linkSectionGrey} fontSize="16px" fontFamily="Roboto Mono">
{text}
</Text>
);
}
} // tslint:disable:max-file-line-count

2
packages/website/ts/components/sidebar_header.tsx
View File

@@ -11,7 +11,7 @@ interface SidebarHeaderState {}
export class SidebarHeader extends React.Component<SidebarHeaderProps, SidebarHeaderState> {
public render(): React.ReactNode {
return (
<div className="pt2 md-px1 sm-px2" style={{ color: colors.black, paddingBottom: 18 }}>
<div style={{ color: colors.black, paddingBottom: 18 }}>
<div className="flex" style={{ fontSize: 25 }}>
<div style={{ fontWeight: 'bold', fontFamily: 'Roboto Mono' }}>0x</div>
<div className="pl2" style={{ lineHeight: 1.4, fontWeight: 300 }}>

3
packages/website/ts/components/top_bar/top_bar.tsx
View File

@@ -35,7 +35,6 @@ export interface TopBarProps {
docsVersion?: string;
availableDocVersions?: string[];
sectionNameToLinks?: ObjectMap<ALink[]>;
subsectionNameToLinks?: ObjectMap<ALink[]>;
displayType?: TopBarDisplayType;
docsInfo?: DocsInfo;
style?: React.CSSProperties;
@@ -313,7 +312,6 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
<div className="lg-hide md-hide">
<NestedSidebarMenu
sectionNameToLinks={this.props.sectionNameToLinks}
subsectionNameToLinks={this.props.subsectionNameToLinks}
sidebarHeader={this.props.sidebarHeader}
shouldDisplaySectionHeaders={false}
onMenuItemClick={this._onMenuButtonClick.bind(this)}
@@ -333,7 +331,6 @@ export class TopBar extends React.Component<TopBarProps, TopBarState> {
<div className="lg-hide md-hide">
<NestedSidebarMenu
sectionNameToLinks={this.props.sectionNameToLinks}
subsectionNameToLinks={this.props.subsectionNameToLinks}
sidebarHeader={this.props.sidebarHeader}
shouldDisplaySectionHeaders={false}
onMenuItemClick={this._onMenuButtonClick.bind(this)}

9
packages/website/ts/containers/docs_home.ts
View File

@@ -1,7 +1,8 @@
import * as _ from 'lodash';
import * as React from 'react';
import { connect } from 'react-redux';
import { Dispatch } from 'redux';
import { Home as HomeComponent, HomeProps } from 'ts/pages/documentation/home';
import { DocsHome as DocsHomeComponent, DocsHomeProps } from 'ts/pages/documentation/docs_home';
import { Dispatcher } from 'ts/redux/dispatcher';
import { State } from 'ts/redux/reducer';
import { ScreenWidths } from 'ts/types';
@@ -16,7 +17,7 @@ interface ConnectedDispatch {
dispatcher: Dispatcher;
}
const mapStateToProps = (state: State, _ownProps: HomeProps): ConnectedState => ({
const mapStateToProps = (state: State, _ownProps: DocsHomeProps): ConnectedState => ({
translate: state.translate,
screenWidth: state.screenWidth,
});
@@ -25,4 +26,6 @@ const mapDispatchToProps = (dispatch: Dispatch<State>): ConnectedDispatch => ({
dispatcher: new Dispatcher(dispatch),
});
export const DocsHome: React.ComponentClass<HomeProps> = connect(mapStateToProps, mapDispatchToProps)(HomeComponent);
export const DocsHome: React.ComponentClass<DocsHomeProps> = connect(mapStateToProps, mapDispatchToProps)(
DocsHomeComponent,
);

176
packages/website/ts/pages/documentation/developers_page.tsx Normal file
View File

@@ -0,0 +1,176 @@
import { ALink, colors, constants as sharedConstants, NestedSidebarMenu } from '@0xproject/react-shared';
import { ObjectMap } from '@0xproject/types';
import * as _ from 'lodash';
import * as React from 'react';
import DocumentTitle = require('react-document-title');
import { DocsLogo } from 'ts/components/documentation/docs_logo';
import { DocsTopBar } from 'ts/components/documentation/docs_top_bar';
import { Container } from 'ts/components/ui/container';
import { Dispatcher } from 'ts/redux/dispatcher';
import { ScreenWidths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
import { utils } from 'ts/utils/utils';
const THROTTLE_TIMEOUT = 100;
const TOP_BAR_HEIGHT = 80;
const SCROLLER_WIDTH = 4;
export interface DevelopersPageProps {
location: Location;
translate: Translate;
screenWidth: ScreenWidths;
dispatcher: Dispatcher;
mainContent: React.ReactNode;
sectionNameToLinks: ObjectMap<ALink[]>;
}
export interface DevelopersPageState {
isHoveringSidebar: boolean;
isHoveringMainContent: boolean;
isSidebarScrolling: boolean;
}
export class DevelopersPage extends React.Component<DevelopersPageProps, DevelopersPageState> {
private readonly _throttledScreenWidthUpdate: () => void;
private readonly _throttledSidebarScrolling: () => void;
private _sidebarScrollClearingInterval: number;
constructor(props: DevelopersPageProps) {
super(props);
this._throttledScreenWidthUpdate = _.throttle(this._updateScreenWidth.bind(this), THROTTLE_TIMEOUT);
this._throttledSidebarScrolling = _.throttle(this._onSidebarScroll.bind(this), THROTTLE_TIMEOUT);
this.state = {
isHoveringSidebar: false,
isHoveringMainContent: false,
isSidebarScrolling: false,
};
}
public componentDidMount(): void {
window.addEventListener('resize', this._throttledScreenWidthUpdate);
window.scrollTo(0, 0);
this._sidebarScrollClearingInterval = window.setInterval(() => {
this.setState({
isSidebarScrolling: false,
});
}, 1000);
}
public componentWillUnmount(): void {
window.removeEventListener('resize', this._throttledScreenWidthUpdate);
window.clearInterval(this._sidebarScrollClearingInterval);
}
public render(): React.ReactNode {
const scrollableContainerStyles: React.CSSProperties = {
position: 'absolute',
top: 80,
left: 0,
bottom: 0,
right: 0,
overflowX: 'hidden',
overflowY: 'scroll',
minHeight: `calc(100vh - ${TOP_BAR_HEIGHT}px)`,
WebkitOverflowScrolling: 'touch',
};
const isSmallScreen = this.props.screenWidth === ScreenWidths.Sm;
const mainContentPadding = isSmallScreen ? 20 : 50;
return (
<Container
className="flex items-center overflow-hidden"
width="100%"
background={`linear-gradient(to right, ${colors.grey100} 0%, ${colors.grey100} 50%, ${
colors.white
} 50%, ${colors.white} 100%)`}
>
<DocumentTitle title="0x Docs DevelopersPage" />
<Container className="flex mx-auto" height="100vh">
<Container
className="sm-hide xs-hide relative"
width={234}
paddingLeft={22}
paddingRight={22}
paddingTop={0}
backgroundColor={colors.grey100}
>
<Container
borderBottom={this.state.isSidebarScrolling ? `1px solid ${colors.grey300}` : 'none'}
>
<Container paddingTop="30px" paddingLeft="10px" paddingBottom="8px">
<DocsLogo height={36} />
</Container>
</Container>
<div
style={{
...scrollableContainerStyles,
paddingTop: 27,
overflow: this.state.isHoveringSidebar ? 'auto' : 'hidden',
}}
onMouseEnter={this._onSidebarHover.bind(this, true)}
onMouseLeave={this._onSidebarHover.bind(this, false)}
onWheel={this._throttledSidebarScrolling}
>
<Container paddingLeft="22px" paddingRight="22px" paddingBottom="100px">
<NestedSidebarMenu
sectionNameToLinks={this.props.sectionNameToLinks}
shouldReformatMenuItemNames={false}
/>
</Container>
</div>
</Container>
<Container
className="relative"
width={isSmallScreen ? '100vw' : 786}
paddingBottom="100px"
backgroundColor={colors.white}
>
<Container paddingLeft={mainContentPadding} paddingRight={mainContentPadding}>
<DocsTopBar
location={this.props.location}
translate={this.props.translate}
sectionNameToLinks={this.props.sectionNameToLinks}
/>
</Container>
<div
id={sharedConstants.SCROLL_CONTAINER_ID}
className="absolute"
style={{
...scrollableContainerStyles,
paddingTop: 30,
paddingLeft: mainContentPadding,
paddingRight: this.state.isHoveringMainContent
? mainContentPadding - SCROLLER_WIDTH
: mainContentPadding,
overflow: this.state.isHoveringMainContent ? 'auto' : 'hidden',
}}
onMouseEnter={this._onMainContentHover.bind(this, true)}
onMouseOver={this._onMainContentHover.bind(this, true)}
onMouseLeave={this._onMainContentHover.bind(this, false)}
>
{this.props.mainContent}
</div>
</Container>
</Container>
</Container>
);
}
private _onSidebarHover(isHovering: boolean, _event: React.FormEvent<HTMLInputElement>): void {
if (isHovering !== this.state.isHoveringSidebar) {
this.setState({
isHoveringSidebar: isHovering,
});
}
}
private _onMainContentHover(isHovering: boolean, _event: React.FormEvent<HTMLInputElement>): void {
if (isHovering !== this.state.isHoveringMainContent) {
this.setState({
isHoveringMainContent: isHovering,
});
}
}
private _onSidebarScroll(_event: React.FormEvent<HTMLInputElement>): void {
this.setState({
isSidebarScrolling: true,
});
}
private _updateScreenWidth(): void {
const newScreenWidth = utils.getScreenWidth();
this.props.dispatcher.updateScreenWidth(newScreenWidth);
}
} // tslint:disable:max-file-line-count

90
packages/website/ts/pages/documentation/doc_page.tsx
View File

@@ -1,35 +1,27 @@
import {
DocAgnosticFormat,
DocReference,
DocsInfo,
Documentation,
GeneratedDocJson,
SupportedDocJson,
TypeDocUtils,
} from '@0xproject/react-docs';
import findVersions = require('find-versions');
import * as _ from 'lodash';
import CircularProgress from 'material-ui/CircularProgress';
import * as React from 'react';
import DocumentTitle = require('react-document-title');
import semverSort = require('semver-sort');
import { SidebarHeader } from 'ts/components/sidebar_header';
import { TopBar } from 'ts/components/top_bar/top_bar';
import { DevelopersPage } from 'ts/pages/documentation/developers_page';
import { Dispatcher } from 'ts/redux/dispatcher';
import { DocPackages } from 'ts/types';
import { DocPackages, ScreenWidths } from 'ts/types';
import { constants } from 'ts/utils/constants';
import { docUtils } from 'ts/utils/doc_utils';
import { Translate } from 'ts/utils/translate';
import { utils } from 'ts/utils/utils';
const isDevelopmentOrStaging = utils.isDevelopment() || utils.isStaging();
const DEFAULT_ICON = 'docs.png';
const ZERO_EX_JS_VERSION_MISSING_TOPLEVEL_PATH = '0.32.4';
const idToIcon: { [id: string]: string } = {
[DocPackages.ZeroExJs]: 'zeroExJs.png',
[DocPackages.Connect]: 'connect.png',
[DocPackages.SmartContracts]: 'contracts.png',
};
const docIdToSubpackageName: { [id: string]: string } = {
[DocPackages.ZeroExJs]: '0x.js',
[DocPackages.Connect]: 'connect',
@@ -52,6 +44,7 @@ export interface DocPageProps {
availableDocVersions: string[];
docsInfo: DocsInfo;
translate: Translate;
screenWidth: ScreenWidths;
}
interface DocPageState {
@@ -79,37 +72,50 @@ export class DocPage extends React.Component<DocPageProps, DocPageState> {
this._isUnmounted = true;
}
public render(): React.ReactNode {
const subsectionNameToLinks = _.isUndefined(this.state.docAgnosticFormat)
? {}
: this.props.docsInfo.getSubsectionNameToLinks(this.state.docAgnosticFormat);
const sourceUrl = this._getSourceUrl();
const iconFileName = idToIcon[this.props.docsInfo.id] || DEFAULT_ICON;
const iconUrl = `/images/doc_icons/${iconFileName}`;
const sectionNameToLinks = _.isUndefined(this.state.docAgnosticFormat)
? {}
: this.props.docsInfo.getSectionNameToLinks(this.state.docAgnosticFormat);
const mainContent = (
<DocReference
selectedVersion={this.props.docsVersion}
availableVersions={this.props.availableDocVersions}
docsInfo={this.props.docsInfo}
docAgnosticFormat={this.state.docAgnosticFormat}
sourceUrl={sourceUrl}
/>
);
return (
<div>
<DocumentTitle title={`${this.props.docsInfo.displayName} Documentation`} />
<TopBar
blockchainIsLoaded={false}
location={this.props.location}
docsVersion={this.props.docsVersion}
availableDocVersions={this.props.availableDocVersions}
sectionNameToLinks={this.props.docsInfo.getSectionNameToLinks()}
subsectionNameToLinks={subsectionNameToLinks}
docsInfo={this.props.docsInfo}
translate={this.props.translate}
onVersionSelected={this._onVersionSelected.bind(this)}
sidebarHeader={<SidebarHeader title={this.props.docsInfo.displayName} iconUrl={iconUrl} />}
/>
<Documentation
selectedVersion={this.props.docsVersion}
availableVersions={this.props.availableDocVersions}
docsInfo={this.props.docsInfo}
docAgnosticFormat={this.state.docAgnosticFormat}
sidebarHeader={<SidebarHeader title={this.props.docsInfo.displayName} iconUrl={iconUrl} />}
sourceUrl={sourceUrl}
topBarHeight={60}
onVersionSelected={this._onVersionSelected.bind(this)}
/>
{_.isUndefined(this.state.docAgnosticFormat) ? (
this._renderLoading()
) : (
<DevelopersPage
mainContent={mainContent}
sectionNameToLinks={sectionNameToLinks}
location={this.props.location}
screenWidth={this.props.screenWidth}
translate={this.props.translate}
dispatcher={this.props.dispatcher}
/>
)}
</div>
);
}
private _renderLoading(): React.ReactNode {
return (
<div className="col col-12">
<div
className="relative sm-px2 sm-pt2 sm-m1"
style={{ height: 122, top: '50%', transform: 'translateY(-50%)' }}
>
<div className="center pb2">
<CircularProgress size={40} thickness={5} />
</div>
<div className="center pt2" style={{ paddingBottom: 11 }}>
Loading documentation...
</div>
</div>
</div>
);
}
@@ -145,10 +151,10 @@ export class DocPage extends React.Component<DocPageProps, DocPageState> {
// documenting solidity.
docAgnosticFormat = versionDocObj as DocAgnosticFormat;
// HACK: need to modify docsInfo like convertToDocAgnosticFormat() would do
this.props.docsInfo.menu.Contracts = [];
this.props.docsInfo.markdownMenu.Contracts = [];
_.each(docAgnosticFormat, (_docObj, sectionName) => {
this.props.docsInfo.sections[sectionName] = sectionName;
this.props.docsInfo.menu.Contracts.push(sectionName);
this.props.docsInfo.markdownMenu.Contracts.push(sectionName);
});
}

359
packages/website/ts/pages/documentation/docs_home.tsx Normal file
View File

@@ -0,0 +1,359 @@
import { ALink } from '@0xproject/react-shared';
import { ObjectMap } from '@0xproject/types';
import * as _ from 'lodash';
import * as React from 'react';
import { OverviewContent } from 'ts/components/documentation/overview_content';
import { DevelopersPage } from 'ts/pages/documentation/developers_page';
import { Dispatcher } from 'ts/redux/dispatcher';
import { Categories, Deco, Key, Package, ScreenWidths, TutorialInfo, WebsitePaths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
const TUTORIALS: TutorialInfo[] = [
{
iconUrl: '/images/developers/tutorials/develop_on_ethereum.svg',
description: Key.DevelopOnEthereumDescription,
link: {
title: Key.DevelopOnEthereum,
to: `${WebsitePaths.Wiki}#Ethereum-Development`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/build_a_relayer.svg',
description: Key.BuildARelayerDescription,
link: {
title: Key.BuildARelayer,
to: `${WebsitePaths.Wiki}#Build-A-Relayer`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/0x_order_basics.svg',
description: Key.OrderBasicsDescription,
link: {
title: Key.OrderBasics,
to: `${WebsitePaths.Wiki}#Create,-Validate,-Fill-Order`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/use_shared_liquidity.svg',
description: Key.UseSharedLiquidityDescription,
link: {
title: Key.UseSharedLiquidity,
to: `${WebsitePaths.Wiki}#Find,-Submit,-Fill-Order-From-Relayer`,
shouldOpenInNewTab: true,
},
},
];
// TODO(fabio): Move this to it's own file
const CATEGORY_TO_PACKAGES: ObjectMap<Package[]> = {
[Categories.ZeroExProtocol]: [
{
description:
'A library for interacting with the 0x protocol. It is a high level package which combines a number of smaller specific-purpose packages such as [order-utils](https://0xproject.com/docs/order-utils) and [contract-wrappers](https://0xproject.com/docs/contract-wrappers).',
link: {
title: '0x.js',
to: WebsitePaths.ZeroExJs,
shouldOpenInNewTab: true,
},
},
{
description:
'A Typescript starter project that will walk you through the basics of how to interact with 0x Protocol and trade of an SRA relayer',
link: {
title: '0x starter project',
to: 'https://github.com/0xProject/0x-starter-project',
shouldOpenInNewTab: true,
},
},
{
description:
'An http & websocket client for interacting with relayers that have implemented the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)',
link: {
title: '@0xproject/connect',
to: WebsitePaths.Connect,
shouldOpenInNewTab: true,
},
},
{
description:
'Typescript/Javascript wrappers of the 0x protocol Ethereum smart contracts. Use this library to call methods on the 0x smart contracts, subscribe to contract events and to fetch information stored in contracts.',
link: {
title: '@0xproject/contract-wrappers',
to: WebsitePaths.ContractWrappers,
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of 0x-related JSON-schemas (incl. SRA request/response schemas, 0x order message format schema, etc...)',
link: {
title: '@0xproject/json-schemas',
to: WebsitePaths.JSONSchemas,
shouldOpenInNewTab: true,
},
},
{
description:
'A set of utils for working with 0x orders. It includes utilities for creating, signing, validating 0x orders, encoding/decoding assetData and much more.',
link: {
title: '@0xproject/order-utils',
to: WebsitePaths.OrderUtils,
shouldOpenInNewTab: true,
},
},
{
description:
"A daemon that watches a set of 0x orders and emits events when an order's fillability has changed. Can be used by a relayer to prune their orderbook or by a trader to keep their view of the market up-to-date.",
link: {
title: '@0xproject/order-watcher',
to: WebsitePaths.OrderWatcher,
shouldOpenInNewTab: true,
},
},
{
description:
'Contains the Standard Relayer API OpenAPI Spec. The package distributes both a javascript object version and a json version.',
link: {
title: '@0xproject/sra-spec',
to: 'https://github.com/0xProject/0x-monorepo/tree/development/packages/sra-spec',
shouldOpenInNewTab: true,
},
},
],
[Categories.Ethereum]: [
{
description:
"This package allows you to generate TypeScript contract wrappers from ABI files. It's heavily inspired by Geth abigen but takes a different approach. You can write your custom handlebars templates which will allow you to seamlessly integrate the generated code into your existing codebase with existing conventions.",
link: {
title: 'abi-gen',
to: 'https://github.com/0xProject/0x-monorepo/tree/development/packages/abi-gen',
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of Typescript types that are useful when working on an Ethereum-based project (e.g RawLog, Transaction, TxData, SolidityTypes, etc...).',
link: {
title: 'ethereum-types',
to: WebsitePaths.EthereumTypes,
shouldOpenInNewTab: true,
},
},
{
description:
'A wrapper around [solc-js](https://github.com/ethereum/solc-js) that adds smart re-compilation, ability to compile an entire project, Solidity version specific compilation, standard input description support and much more.',
link: {
title: '@0xproject/sol-compiler',
to: WebsitePaths.SolCompiler,
shouldOpenInNewTab: true,
},
},
{
description:
'A Solidity code coverage tool. Sol-cov uses transaction traces to figure out which lines of your code has been covered by your tests.',
link: {
title: '@0xproject/sol-cov',
to: WebsitePaths.SolCov,
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of subproviders to use with [web3-provider-engine](https://www.npmjs.com/package/web3-provider-engine) (e.g subproviders for interfacing with Ledger hardware wallet, Mnemonic wallet, private key wallet, etc...)',
link: {
title: '@0xproject/subproviders',
to: WebsitePaths.Subproviders,
shouldOpenInNewTab: true,
},
},
{
description:
'A raw Ethereum JSON RPC client to simplify interfacing with Ethereum nodes. Also includes some convenience functions for awaiting transactions to be mined, converting between token units, etc...',
link: {
title: '@0xproject/web3-wrapper',
to: WebsitePaths.Web3Wrapper,
shouldOpenInNewTab: true,
},
},
],
[Categories.CommunityMaintained]: [
{
description:
'Node.js worker originally built for 0x Tracker which extracts 0x fill events from the Ethereum blockchain and persists them to MongoDB. Support for both V1 and V2 of the 0x protocol is included with events tagged against the protocol version they belong to.',
link: {
title: '0x Event Extractor',
to: 'https://github.com/0xTracker/0x-event-extractor',
shouldOpenInNewTab: true,
},
},
{
description:
'Node.js worker built for 0x Tracker which performs various ETL tasks related to the 0x protocol trading data and other information used on 0x Tracker.',
link: {
title: '0x Tracker Worker',
to: 'https://github.com/0xTracker/0x-tracker-worker',
shouldOpenInNewTab: true,
},
},
{
description:
"ERCdex's Javascript SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
title: 'Aquaduct',
to: 'https://www.npmjs.com/package/aqueduct',
shouldOpenInNewTab: true,
},
},
{
description:
'SDKs for automation using Aqueduct & ERC dEX. Aqueduct Server is a lightweight, portable and secure server that runs locally on any workstation. The server exposes a small number of foundational endpoints that enable working with the decentralized Aqueduct liquidity pool from any context or programming language.',
link: {
title: 'Aquaduct Server SDK',
to: 'https://github.com/ERCdEX/aqueduct-server-sdk',
shouldOpenInNewTab: true,
},
},
{
description: 'A node.js SDK for trading on the DDEX relayer',
link: {
to: 'https://www.npmjs.com/package/ddex-api',
title: 'DDEX Node.js SDK',
shouldOpenInNewTab: true,
},
},
{
description: "The ERC dEX Trade Widget let's any website provide token liquidity to it's users",
link: {
to: 'https://github.com/ERCdEX/widget',
title: 'ERCdex Widget',
shouldOpenInNewTab: true,
},
},
{
description: "ERCdex's Java SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
to: 'https://github.com/ERCdEX/java',
title: 'ERCdex Java SDK',
shouldOpenInNewTab: true,
},
},
{
description: "ERCdex's Python SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
to: 'https://github.com/ERCdEX/python',
title: 'ERCdex Python SDK',
shouldOpenInNewTab: true,
},
},
{
description:
'A set of command-line tools for creating command-line scripts for interacting with the Ethereum blockchain in general, and 0x in particular',
link: {
title: 'Massive',
to: 'https://github.com/NoteGio/massive',
shouldOpenInNewTab: true,
},
},
{
description: 'An open-source API-only Relayer written in Go',
link: {
to: 'https://github.com/NoteGio/openrelay',
title: 'OpenRelay',
shouldOpenInNewTab: true,
},
},
{
description:
'A JavaScript Library for Interacting with OpenRelay.xyz and other 0x Standard Relayer API Implementations',
link: {
title: 'OpenRelay.js',
to: 'https://github.com/NoteGio/openrelay.js',
shouldOpenInNewTab: true,
},
},
{
description:
'The Radar Relay SDK is a software development kit that simplifies the interactions with Radar Relay’s APIs',
link: {
title: 'Radar SDK',
to: 'https://github.com/RadarRelay/sdk',
shouldOpenInNewTab: true,
},
},
{
description:
'The Ocean provides a simple REST API, WebSockets API, and JavaScript library to help you integrate decentralized trading into your existing trading strategy.',
link: {
title: 'The Ocean Javascript SDK',
to: 'https://github.com/TheOceanTrade/theoceanx-javascript',
shouldOpenInNewTab: true,
},
},
{
description: "Tokenlon SDK provides APIs for developers to trade of imToken's relayer",
link: {
to: 'https://www.npmjs.com/package/tokenlon-sdk',
title: 'Tokenlon Javascript SDK',
shouldOpenInNewTab: true,
},
},
{
description: 'A small library that implements the 0x order assetData encoding/decoding in Java',
link: {
to: 'https://github.com/wildnothing/asset-data-decoder',
title: 'AssetData decoder library in Java',
shouldOpenInNewTab: true,
},
},
],
};
export interface DocsHomeProps {
location: Location;
translate: Translate;
screenWidth: ScreenWidths;
tutorials: TutorialInfo[];
categoryToPackages: ObjectMap<Package[]>;
dispatcher: Dispatcher;
}
export interface DocsHomeState {}
export class DocsHome extends React.Component<DocsHomeProps, DocsHomeState> {
public render(): React.ReactNode {
const sectionNameToLinks: ObjectMap<ALink[]> = {
'Starter guides': _.map(TUTORIALS, tutorialInfo => {
return {
...tutorialInfo.link,
title: this.props.translate.get(tutorialInfo.link.title as Key, Deco.Cap),
};
}),
[Categories.ZeroExProtocol]: _.map(CATEGORY_TO_PACKAGES[Categories.ZeroExProtocol], pkg => pkg.link),
[Categories.Ethereum]: _.map(CATEGORY_TO_PACKAGES[Categories.Ethereum], pkg => pkg.link),
[Categories.CommunityMaintained]: _.map(
CATEGORY_TO_PACKAGES[Categories.CommunityMaintained],
pkg => pkg.link,
),
};
const mainContent = (
<OverviewContent
translate={this.props.translate}
tutorials={TUTORIALS}
categoryToPackages={CATEGORY_TO_PACKAGES}
/>
);
return (
<DevelopersPage
mainContent={mainContent}
sectionNameToLinks={sectionNameToLinks}
location={this.props.location}
screenWidth={this.props.screenWidth}
translate={this.props.translate}
dispatcher={this.props.dispatcher}
/>
);
}
}

623
packages/website/ts/pages/documentation/home.tsx
View File

@@ -1,623 +0,0 @@
import {
ALink,
colors,
constants as sharedConstants,
Link,
MarkdownLinkBlock,
NestedSidebarMenu,
utils as sharedUtils,
} from '@0xproject/react-shared';
import { ObjectMap } from '@0xproject/types';
import * as _ from 'lodash';
import * as React from 'react';
import DocumentTitle = require('react-document-title');
import * as ReactMarkdown from 'react-markdown';
import { Element as ScrollElement } from 'react-scroll';
import { DocsLogo } from 'ts/components/documentation/docs_logo';
import { DocsTopBar } from 'ts/components/documentation/docs_top_bar';
import { TutorialButton } from 'ts/components/documentation/tutorial_button';
import { Container } from 'ts/components/ui/container';
import { Text } from 'ts/components/ui/text';
import { Dispatcher } from 'ts/redux/dispatcher';
import { Deco, Key, ScreenWidths, TutorialInfo, WebsitePaths } from 'ts/types';
import { Translate } from 'ts/utils/translate';
import { utils } from 'ts/utils/utils';
const THROTTLE_TIMEOUT = 100;
const TOP_BAR_HEIGHT = 80;
const SCROLLER_WIDTH = 4;
const TUTORIALS: TutorialInfo[] = [
{
iconUrl: '/images/developers/tutorials/develop_on_ethereum.svg',
description: Key.DevelopOnEthereumDescription,
link: {
title: Key.DevelopOnEthereum,
to: `${WebsitePaths.Wiki}#Ethereum-Development`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/build_a_relayer.svg',
description: Key.BuildARelayerDescription,
link: {
title: Key.BuildARelayer,
to: `${WebsitePaths.Wiki}#Build-A-Relayer`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/0x_order_basics.svg',
description: Key.OrderBasicsDescription,
link: {
title: Key.OrderBasics,
to: `${WebsitePaths.Wiki}#Create,-Validate,-Fill-Order`,
shouldOpenInNewTab: true,
},
},
{
iconUrl: '/images/developers/tutorials/use_shared_liquidity.svg',
description: Key.UseSharedLiquidityDescription,
link: {
title: Key.UseSharedLiquidity,
to: `${WebsitePaths.Wiki}#Find,-Submit,-Fill-Order-From-Relayer`,
shouldOpenInNewTab: true,
},
},
];
enum Categories {
ZeroExProtocol = '0x Protocol',
Ethereum = 'Ethereum',
CommunityMaintained = 'Community Maintained',
}
// TODO(fabio): Move this to it's own file
const CATEGORY_TO_PACKAGES: { [category: string]: Package[] } = {
[Categories.ZeroExProtocol]: [
{
description:
'A library for interacting with the 0x protocol. It is a high level package which combines a number of smaller specific-purpose packages such as [order-utils](https://0xproject.com/docs/order-utils) and [contract-wrappers](https://0xproject.com/docs/contract-wrappers).',
link: {
title: '0x.js',
to: WebsitePaths.ZeroExJs,
shouldOpenInNewTab: true,
},
},
{
description:
'A Typescript starter project that will walk you through the basics of how to interact with 0x Protocol and trade of an SRA relayer',
link: {
title: '0x starter project',
to: 'https://github.com/0xProject/0x-starter-project',
shouldOpenInNewTab: true,
},
},
{
description:
'An http & websocket client for interacting with relayers that have implemented the [Standard Relayer API](https://github.com/0xProject/standard-relayer-api)',
link: {
title: '@0xproject/connect',
to: WebsitePaths.Connect,
shouldOpenInNewTab: true,
},
},
{
description:
'Typescript/Javascript wrappers of the 0x protocol Ethereum smart contracts. Use this library to call methods on the 0x smart contracts, subscribe to contract events and to fetch information stored in contracts.',
link: {
title: '@0xproject/contract-wrappers',
to: WebsitePaths.ContractWrappers,
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of 0x-related JSON-schemas (incl. SRA request/response schemas, 0x order message format schema, etc...)',
link: {
title: '@0xproject/json-schemas',
to: WebsitePaths.JSONSchemas,
shouldOpenInNewTab: true,
},
},
{
description:
'A set of utils for working with 0x orders. It includes utilities for creating, signing, validating 0x orders, encoding/decoding assetData and much more.',
link: {
title: '@0xproject/order-utils',
to: WebsitePaths.OrderUtils,
shouldOpenInNewTab: true,
},
},
{
description:
"A daemon that watches a set of 0x orders and emits events when an order's fillability has changed. Can be used by a relayer to prune their orderbook or by a trader to keep their view of the market up-to-date.",
link: {
title: '@0xproject/order-watcher',
to: WebsitePaths.OrderWatcher,
shouldOpenInNewTab: true,
},
},
{
description:
'Contains the Standard Relayer API OpenAPI Spec. The package distributes both a javascript object version and a json version.',
link: {
title: '@0xproject/sra-spec',
to: 'https://github.com/0xProject/0x-monorepo/tree/development/packages/sra-spec',
shouldOpenInNewTab: true,
},
},
],
[Categories.Ethereum]: [
{
description:
"This package allows you to generate TypeScript contract wrappers from ABI files. It's heavily inspired by Geth abigen but takes a different approach. You can write your custom handlebars templates which will allow you to seamlessly integrate the generated code into your existing codebase with existing conventions.",
link: {
title: 'abi-gen',
to: 'https://github.com/0xProject/0x-monorepo/tree/development/packages/abi-gen',
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of Typescript types that are useful when working on an Ethereum-based project (e.g RawLog, Transaction, TxData, SolidityTypes, etc...).',
link: {
title: 'ethereum-types',
to: WebsitePaths.EthereumTypes,
shouldOpenInNewTab: true,
},
},
{
description:
'A wrapper around [solc-js](https://github.com/ethereum/solc-js) that adds smart re-compilation, ability to compile an entire project, Solidity version specific compilation, standard input description support and much more.',
link: {
title: '@0xproject/sol-compiler',
to: WebsitePaths.SolCompiler,
shouldOpenInNewTab: true,
},
},
{
description:
'A Solidity code coverage tool. Sol-cov uses transaction traces to figure out which lines of your code has been covered by your tests.',
link: {
title: '@0xproject/sol-cov',
to: WebsitePaths.SolCov,
shouldOpenInNewTab: true,
},
},
{
description:
'A collection of subproviders to use with [web3-provider-engine](https://www.npmjs.com/package/web3-provider-engine) (e.g subproviders for interfacing with Ledger hardware wallet, Mnemonic wallet, private key wallet, etc...)',
link: {
title: '@0xproject/subproviders',
to: WebsitePaths.Subproviders,
shouldOpenInNewTab: true,
},
},
{
description:
'A raw Ethereum JSON RPC client to simplify interfacing with Ethereum nodes. Also includes some convenience functions for awaiting transactions to be mined, converting between token units, etc...',
link: {
title: '@0xproject/web3-wrapper',
to: WebsitePaths.Web3Wrapper,
shouldOpenInNewTab: true,
},
},
],
[Categories.CommunityMaintained]: [
{
description:
'Node.js worker originally built for 0x Tracker which extracts 0x fill events from the Ethereum blockchain and persists them to MongoDB. Support for both V1 and V2 of the 0x protocol is included with events tagged against the protocol version they belong to.',
link: {
title: '0x Event Extractor',
to: 'https://github.com/0xTracker/0x-event-extractor',
shouldOpenInNewTab: true,
},
},
{
description:
'Node.js worker built for 0x Tracker which performs various ETL tasks related to the 0x protocol trading data and other information used on 0x Tracker.',
link: {
title: '0x Tracker Worker',
to: 'https://github.com/0xTracker/0x-tracker-worker',
shouldOpenInNewTab: true,
},
},
{
description:
"ERCdex's Javascript SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
title: 'Aquaduct',
to: 'https://www.npmjs.com/package/aqueduct',
shouldOpenInNewTab: true,
},
},
{
description:
'SDKs for automation using Aqueduct & ERC dEX. Aqueduct Server is a lightweight, portable and secure server that runs locally on any workstation. The server exposes a small number of foundational endpoints that enable working with the decentralized Aqueduct liquidity pool from any context or programming language.',
link: {
title: 'Aquaduct Server SDK',
to: 'https://github.com/ERCdEX/aqueduct-server-sdk',
shouldOpenInNewTab: true,
},
},
{
description: 'A node.js SDK for trading on the DDEX relayer',
link: {
to: 'https://www.npmjs.com/package/ddex-api',
title: 'DDEX Node.js SDK',
shouldOpenInNewTab: true,
},
},
{
description: "The ERC dEX Trade Widget let's any website provide token liquidity to it's users",
link: {
to: 'https://github.com/ERCdEX/widget',
title: 'ERCdex Widget',
shouldOpenInNewTab: true,
},
},
{
description: "ERCdex's Java SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
to: 'https://github.com/ERCdEX/java',
title: 'ERCdex Java SDK',
shouldOpenInNewTab: true,
},
},
{
description: "ERCdex's Python SDK for trading on their relayer, as well as other Aquaduct partner relayers",
link: {
to: 'https://github.com/ERCdEX/python',
title: 'ERCdex Python SDK',
shouldOpenInNewTab: true,
},
},
{
description:
'A set of command-line tools for creating command-line scripts for interacting with the Ethereum blockchain in general, and 0x in particular',
link: {
title: 'Massive',
to: 'https://github.com/NoteGio/massive',
shouldOpenInNewTab: true,
},
},
{
description: 'An open-source API-only Relayer written in Go',
link: {
to: 'https://github.com/NoteGio/openrelay',
title: 'OpenRelay',
shouldOpenInNewTab: true,
},
},
{
description:
'A JavaScript Library for Interacting with OpenRelay.xyz and other 0x Standard Relayer API Implementations',
link: {
title: 'OpenRelay.js',
to: 'https://github.com/NoteGio/openrelay.js',
shouldOpenInNewTab: true,
},
},
{
description:
'The Radar Relay SDK is a software development kit that simplifies the interactions with Radar Relay’s APIs',
link: {
title: 'Radar SDK',
to: 'https://github.com/RadarRelay/sdk',
shouldOpenInNewTab: true,
},
},
{
description:
'The Ocean provides a simple REST API, WebSockets API, and JavaScript library to help you integrate decentralized trading into your existing trading strategy.',
link: {
title: 'The Ocean Javascript SDK',
to: 'https://github.com/TheOceanTrade/theoceanx-javascript',
shouldOpenInNewTab: true,
},
},
{
description: "Tokenlon SDK provides APIs for developers to trade of imToken's relayer",
link: {
to: 'https://www.npmjs.com/package/tokenlon-sdk',
title: 'Tokenlon Javascript SDK',
shouldOpenInNewTab: true,
},
},
{
description: 'A small library that implements the 0x order assetData encoding/decoding in Java',
link: {
to: 'https://github.com/wildnothing/asset-data-decoder',
title: 'AssetData decoder library in Java',
shouldOpenInNewTab: true,
},
},
],
};
interface Package {
description: string;
link: ALink;
}
export interface HomeProps {
location: Location;
translate: Translate;
screenWidth: ScreenWidths;
dispatcher: Dispatcher;
}
export interface HomeState {
isHoveringSidebar: boolean;
isHoveringMainContent: boolean;
isSidebarScrolling: boolean;
}
export class Home extends React.Component<HomeProps, HomeState> {
private readonly _throttledScreenWidthUpdate: () => void;
private readonly _throttledSidebarScrolling: () => void;
private _sidebarScrollClearingInterval: number;
constructor(props: HomeProps) {
super(props);
this._throttledScreenWidthUpdate = _.throttle(this._updateScreenWidth.bind(this), THROTTLE_TIMEOUT);
this._throttledSidebarScrolling = _.throttle(this._onSidebarScroll.bind(this), THROTTLE_TIMEOUT);
this.state = {
isHoveringSidebar: false,
isHoveringMainContent: false,
isSidebarScrolling: false,
};
}
public componentDidMount(): void {
window.addEventListener('resize', this._throttledScreenWidthUpdate);
window.scrollTo(0, 0);
this._sidebarScrollClearingInterval = window.setInterval(() => {
this.setState({
isSidebarScrolling: false,
});
}, 1000);
}
public componentWillUnmount(): void {
window.removeEventListener('resize', this._throttledScreenWidthUpdate);
window.clearInterval(this._sidebarScrollClearingInterval);
}
public render(): React.ReactNode {
const scrollableContainerStyles: React.CSSProperties = {
position: 'absolute',
top: 80,
left: 0,
bottom: 0,
right: 0,
overflowX: 'hidden',
overflowY: 'scroll',
minHeight: `calc(100vh - ${TOP_BAR_HEIGHT}px)`,
WebkitOverflowScrolling: 'touch',
};
const isSmallScreen = this.props.screenWidth === ScreenWidths.Sm;
const mainContentPadding = isSmallScreen ? 20 : 50;
const sectionNameToLinks: ObjectMap<ALink[]> = {
'Starter guides': _.map(TUTORIALS, tutorialInfo => {
return {
...tutorialInfo.link,
title: this.props.translate.get(tutorialInfo.link.title as Key, Deco.Cap),
};
}),
[Categories.ZeroExProtocol]: _.map(CATEGORY_TO_PACKAGES[Categories.ZeroExProtocol], pkg => pkg.link),
[Categories.Ethereum]: _.map(CATEGORY_TO_PACKAGES[Categories.Ethereum], pkg => pkg.link),
[Categories.CommunityMaintained]: _.map(
CATEGORY_TO_PACKAGES[Categories.CommunityMaintained],
pkg => pkg.link,
),
};
return (
<Container
className="flex items-center overflow-hidden"
width="100%"
background={`linear-gradient(to right, ${colors.grey100} 0%, ${colors.grey100} 50%, ${
colors.white
} 50%, ${colors.white} 100%)`}
>
<DocumentTitle title="0x Docs Home" />
<Container className="flex mx-auto" height="100vh">
<Container
className="sm-hide xs-hide relative"
width={234}
paddingLeft={22}
paddingRight={22}
paddingTop={0}
backgroundColor={colors.grey100}
>
<Container
borderBottom={this.state.isSidebarScrolling ? `1px solid ${colors.grey300}` : 'none'}
>
<Container paddingTop="30px" paddingLeft="10px" paddingBottom="8px">
<DocsLogo height={36} />
</Container>
</Container>
<div
style={{
...scrollableContainerStyles,
paddingTop: 27,
overflow: this.state.isHoveringSidebar ? 'auto' : 'hidden',
}}
onMouseEnter={this._onSidebarHover.bind(this, true)}
onMouseLeave={this._onSidebarHover.bind(this, false)}
onWheel={this._throttledSidebarScrolling}
>
<Container paddingLeft="22px" paddingRight="22px" paddingBottom="100px">
<NestedSidebarMenu
sectionNameToLinks={sectionNameToLinks}
shouldReformatMenuItemNames={false}
/>
</Container>
</div>
</Container>
<Container
className="relative"
width={isSmallScreen ? '100vw' : 786}
paddingBottom="100px"
backgroundColor={colors.white}
>
<Container paddingLeft={mainContentPadding} paddingRight={mainContentPadding}>
<DocsTopBar
location={this.props.location}
translate={this.props.translate}
sectionNameToLinks={sectionNameToLinks}
/>
</Container>
<div
id={sharedConstants.SCROLL_CONTAINER_ID}
className="absolute"
style={{
...scrollableContainerStyles,
paddingTop: 30,
paddingLeft: mainContentPadding,
paddingRight: this.state.isHoveringMainContent
? mainContentPadding - SCROLLER_WIDTH
: mainContentPadding,
overflow: this.state.isHoveringMainContent ? 'auto' : 'hidden',
}}
onMouseEnter={this._onMainContentHover.bind(this, true)}
onMouseOver={this._onMainContentHover.bind(this, true)}
onMouseLeave={this._onMainContentHover.bind(this, false)}
>
<Container>
{this._renderSectionTitle(this.props.translate.get(Key.StartBuildOn0x, Deco.Cap))}
<Container paddingTop="12px">
{this._renderSectionDescription(
this.props.translate.get(Key.StartBuildOn0xDescription, Deco.Cap),
)}
<Container marginTop="36px">
{_.map(TUTORIALS, tutorialInfo => (
<ScrollElement
name={sharedUtils.getIdFromName(
this.props.translate.get(tutorialInfo.link.title as Key, Deco.Cap),
)}
key={`tutorial-${tutorialInfo.link.title}`}
>
<TutorialButton
translate={this.props.translate}
tutorialInfo={tutorialInfo}
/>
</ScrollElement>
))}
</Container>
</Container>
<Container marginTop="32px" paddingBottom="100px">
{this._renderSectionTitle(
this.props.translate.get(Key.LibrariesAndTools, Deco.CapWords),
)}
<Container paddingTop="12px">
{this._renderSectionDescription(
this.props.translate.get(Key.LibrariesAndToolsDescription, Deco.Cap),
)}
<Container marginTop="36px">
{_.map(CATEGORY_TO_PACKAGES, (pkgs, category) =>
this._renderPackageCategory(category, pkgs),
)}
</Container>
</Container>
</Container>
</Container>
</div>
</Container>
</Container>
</Container>
);
}
private _renderPackageCategory(category: string, pkgs: Package[]): React.ReactNode {
return (
<Container key={`category-${category}`}>
<Text fontSize="18px">{category}</Text>
<Container>{_.map(pkgs, pkg => this._renderPackage(pkg))}</Container>
</Container>
);
}
private _renderPackage(pkg: Package): React.ReactNode {
const id = sharedUtils.getIdFromName(pkg.link.title);
return (
<ScrollElement name={id} key={`package-${pkg.link.title}`}>
<Container className="pb2">
<Container width="100%" height="1px" backgroundColor={colors.grey300} marginTop="11px" />
<Container className="clearfix mt2 pt1">
<Container className="md-col lg-col md-col-4 lg-col-4">
<Link
to={pkg.link.to}
fontColor={colors.lightLinkBlue}
shouldOpenInNewTab={!!pkg.link.shouldOpenInNewTab}
>
<Text Tag="div" fontColor={colors.lightLinkBlue} fontWeight="bold">
{pkg.link.title}
</Text>
</Link>
</Container>
<Container className="md-col lg-col md-col-6 lg-col-6 sm-py2">
<Text fontColor={colors.grey700}>
<ReactMarkdown
source={pkg.description}
renderers={{
link: MarkdownLinkBlock,
paragraph: 'span',
}}
/>
</Text>
</Container>
<Container className="md-col lg-col md-col-2 lg-col-2 sm-pb2 relative">
<Container position="absolute" right="0px">
<Link
to={pkg.link.to}
fontColor={colors.lightLinkBlue}
shouldOpenInNewTab={!!pkg.link.shouldOpenInNewTab}
>
<Container className="flex">
<Container>{this.props.translate.get(Key.More, Deco.Cap)}</Container>
<Container paddingTop="1px" paddingLeft="6px">
<i
className="zmdi zmdi-chevron-right bold"
style={{ fontSize: 18, color: colors.lightLinkBlue }}
/>
</Container>
</Container>
</Link>
</Container>
</Container>
</Container>
</Container>
</ScrollElement>
);
}
private _renderSectionTitle(text: string): React.ReactNode {
return (
<Text fontColor={colors.projectsGrey} fontSize="30px" fontWeight="bold">
{text}
</Text>
);
}
private _renderSectionDescription(text: string): React.ReactNode {
return (
<Text fontColor={colors.linkSectionGrey} fontSize="16px" fontFamily="Roboto Mono">
{text}
</Text>
);
}
private _onSidebarHover(isHovering: boolean, _event: React.FormEvent<HTMLInputElement>): void {
if (isHovering !== this.state.isHoveringSidebar) {
this.setState({
isHoveringSidebar: isHovering,
});
}
}
private _onMainContentHover(isHovering: boolean, _event: React.FormEvent<HTMLInputElement>): void {
if (isHovering !== this.state.isHoveringMainContent) {
this.setState({
isHoveringMainContent: isHovering,
});
}
}
private _onSidebarScroll(_event: React.FormEvent<HTMLInputElement>): void {
this.setState({
isSidebarScrolling: true,
});
}
private _updateScreenWidth(): void {
const newScreenWidth = utils.getScreenWidth();
this.props.dispatcher.updateScreenWidth(newScreenWidth);
}
} // tslint:disable:max-file-line-count

11
packages/website/ts/types.ts
View File

@@ -624,4 +624,15 @@ export interface TutorialInfo {
description: string;
link: ALink;
}
export enum Categories {
ZeroExProtocol = '0x Protocol',
Ethereum = 'Ethereum',
CommunityMaintained = 'Community Maintained',
}
export interface Package {
description: string;
link: ALink;
}
// tslint:disable:max-file-line-count