From fdbc235fd67db335d99dbd89f7f706c4290161ce Mon Sep 17 00:00:00 2001 From: Piotr Janosz Date: Tue, 13 Aug 2019 15:03:51 +0200 Subject: [PATCH] [WIP] new tools --- packages/website/mdx/api-explorer/index.mdx | 0 .../{core-concepts.mdx => index.mdx} | 0 .../@0x/asset-buyer/v6.1.11/reference.mdx | 40 +-- .../ts/components/docs/sidebar/select.tsx | 9 +- .../docs/sidebar/sidebar_wrapper.tsx | 16 +- .../docs/sidebar/table_of_contents.tsx | 45 +++- packages/website/ts/components/text.tsx | 4 +- packages/website/ts/index.tsx | 242 ++++++++---------- packages/website/ts/pages/docs/page.tsx | 17 +- packages/website/ts/style/docs.ts | 2 +- packages/website/ts/types.ts | 4 +- packages/website/ts/utils/algolia_meta.ts | 11 +- packages/website/webpack.config.js | 1 + 13 files changed, 219 insertions(+), 172 deletions(-) create mode 100644 packages/website/mdx/api-explorer/index.mdx rename packages/website/mdx/core-concepts/{core-concepts.mdx => index.mdx} (100%) diff --git a/packages/website/mdx/api-explorer/index.mdx b/packages/website/mdx/api-explorer/index.mdx new file mode 100644 index 0000000000..e69de29bb2 diff --git a/packages/website/mdx/core-concepts/core-concepts.mdx b/packages/website/mdx/core-concepts/index.mdx similarity index 100% rename from packages/website/mdx/core-concepts/core-concepts.mdx rename to packages/website/mdx/core-concepts/index.mdx diff --git a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx index 81dec0d125..fa75efc42f 100644 --- a/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx +++ b/packages/website/mdx/tools/@0x/asset-buyer/v6.1.11/reference.mdx @@ -1,6 +1,6 @@ -> # Class: AssetBuyer +# AssetBuyer -## Hierarchy + ## Constructors -### constructor +Constructor \+ **new AssetBuyer**(`supportedProvider`: `SupportedProvider`, `orderProvider`: [OrderProvider](#class-assetbuyer)* @@ -55,7 +55,7 @@ An instance of AssetBuyer ### expiryBufferSeconds -• **expiryBufferSeconds**: *number* +`expiryBufferSeconds: number` *Defined in [asset_buyer.ts:41](https://github.com/0xProject/0x-monorepo/blob/6dd77d5c8/packages/asset-buyer/src/asset_buyer.ts#L41)* @@ -259,7 +259,7 @@ An instance of AssetBuyer
-> # Class: InsufficientAssetLiquidityError +# Class: InsufficientAssetLiquidityError Error class representing insufficient asset liquidity @@ -351,7 +351,7 @@ Defined in /Users/rickmorty/Documents/projects/0x/0x-monorepo/node_modules/typed
-> # Class: BasicOrderProvider +# Class: BasicOrderProvider ## Hierarchy @@ -446,7 +446,7 @@ An instance of OrderProviderResponse. See type for more information.
-> # Class: StandardRelayerAPIOrderProvider +# Class: StandardRelayerAPIOrderProvider ## Hierarchy @@ -551,7 +551,7 @@ An instance of OrderProviderResponse. See type for more information.
-> # Enumeration: AssetBuyerError +# Enumeration: AssetBuyerError Possible error messages thrown by an AssetBuyer instance or associated static methods. @@ -652,7 +652,7 @@ ___
-> # Interface: AssetBuyerOpts +# Interface: AssetBuyerOpts networkId: The ethereum network id. Defaults to 1 (mainnet). orderRefreshIntervalMs: The interval in ms that getBuyQuoteAsync should trigger an refresh of orders and order states. Defaults to 10000ms (10s). @@ -696,7 +696,7 @@ ___
-> # Interface: BuyQuote +# Interface: BuyQuote assetData: String that represents a specific asset (for more info: https://github.com/0xProject/0x-protocol-specification/blob/master/v2/v2-specification.md). assetBuyAmount: The amount of asset to buy. @@ -780,7 +780,7 @@ ___
-> # Interface: BuyQuoteExecutionOpts +# Interface: BuyQuoteExecutionOpts ethAmount: The desired amount of eth to spend. Defaults to buyQuote.worstCaseQuoteInfo.totalEthAmount. takerAddress: The address to perform the buy. Defaults to the first available address from the provider. @@ -844,7 +844,7 @@ ___
-> # Interface: BuyQuoteInfo +# Interface: BuyQuoteInfo assetEthAmount: The amount of eth required to pay for the requested asset. feeEthAmount: The amount of eth required to pay the affiliate fee. @@ -888,7 +888,7 @@ ___
-> # Interface: BuyQuoteRequestOpts +# Interface: BuyQuoteRequestOpts feePercentage: The affiliate fee percentage. Defaults to 0. shouldForceOrderRefresh: If set to true, new orders and state will be fetched instead of waiting for the next orderRefreshIntervalMs. Defaults to false. @@ -932,7 +932,7 @@ ___
-> # Interface: LiquidityForAssetData +# Interface: LiquidityForAssetData Represents available liquidity for a given assetData @@ -965,7 +965,7 @@ ___
-> # Interface: OrderProvider +# Interface: OrderProvider gerOrdersAsync: Given an OrderProviderRequest, get an OrderProviderResponse. getAvailableMakerAssetDatasAsync: Given a taker asset data string, return all availabled paired maker asset data strings. @@ -1024,7 +1024,7 @@ Name | Type |
-> # Interface: OrderProviderRequest +# Interface: OrderProviderRequest makerAssetData: The assetData representing the desired makerAsset. takerAssetData: The assetData representing the desired takerAsset. @@ -1059,7 +1059,7 @@ ___
-> # Interface: OrderProviderResponse +# Interface: OrderProviderResponse orders: An array of orders with optional remaining fillable makerAsset amounts. See type for more info. @@ -1083,7 +1083,7 @@ orders: An array of orders with optional remaining fillable makerAsset amounts.
-> # Interface: OrdersAndFillableAmounts +# Interface: OrdersAndFillableAmounts orders: An array of signed orders remainingFillableMakerAssetAmounts: A list of fillable amounts for the signed orders. The index of an item in the array associates the amount with the corresponding order. @@ -1117,7 +1117,7 @@ ___
-> # Interface: SignedOrderWithRemainingFillableMakerAssetAmount +# Interface: SignedOrderWithRemainingFillableMakerAssetAmount A normal SignedOrder with one extra optional property `remainingFillableMakerAssetAmount` remainingFillableMakerAssetAmount: The amount of the makerAsset that is available to be filled diff --git a/packages/website/ts/components/docs/sidebar/select.tsx b/packages/website/ts/components/docs/sidebar/select.tsx index 4626545e37..83d796b82f 100644 --- a/packages/website/ts/components/docs/sidebar/select.tsx +++ b/packages/website/ts/components/docs/sidebar/select.tsx @@ -55,12 +55,17 @@ const Wrapper = styled.div` `; const Container = styled.div` - border: 1px solid ${colors.brandDark}; + border: 1px solid #e3e3e3; border-radius: 4px; display: inline-block; margin-left: 12px; position: relative; + transition: all 250ms ease-in-out; + &:hover { + border-color: ${colors.brandDark}; + } + svg { pointer-events: none; position: absolute; @@ -72,7 +77,7 @@ const Container = styled.div` const StyledSelect = styled.select` appearance: none; - background-color: #fff; + background-color: transparent; border: none; cursor: pointer; outline: none; diff --git a/packages/website/ts/components/docs/sidebar/sidebar_wrapper.tsx b/packages/website/ts/components/docs/sidebar/sidebar_wrapper.tsx index c8cdda90af..49babc3d2d 100644 --- a/packages/website/ts/components/docs/sidebar/sidebar_wrapper.tsx +++ b/packages/website/ts/components/docs/sidebar/sidebar_wrapper.tsx @@ -4,6 +4,7 @@ import styled from 'styled-components'; import { Collapse } from 'ts/components/docs/sidebar/collapse'; +import { colors } from 'ts/style/colors'; import { docs } from 'ts/style/docs'; interface ISidebarWrapperProps { @@ -31,9 +32,22 @@ const SidebarAside = styled.aside` const SidebarContent = styled.div` position: sticky; top: ${docs.headerOffset}px; /* To make space for the header (react-headroom) when clicking on links */ - max-height: 60vh; + max-height: 85vh; overflow-y: auto; + /* Slim scroll bar */ + scrollbar-color: ${colors.grey500}; + scrollbar-width: 1px; /* Firefox */ + -ms-overflow-style: none; /* IE 10+ */ + &::-webkit-scrollbar { + height: 1px; + width: 1px; + background: transparent; /* Chrome / Safari / Webkit */ + } + &::-webkit-scrollbar-thumb { + background-color: ${colors.grey350}; + } + @media (max-width: 900px) { max-height: 100%; } diff --git a/packages/website/ts/components/docs/sidebar/table_of_contents.tsx b/packages/website/ts/components/docs/sidebar/table_of_contents.tsx index 3d61ff2460..bec9890513 100644 --- a/packages/website/ts/components/docs/sidebar/table_of_contents.tsx +++ b/packages/website/ts/components/docs/sidebar/table_of_contents.tsx @@ -8,6 +8,8 @@ import { docs } from 'ts/style/docs'; import { SidebarWrapper } from 'ts/components/docs/sidebar/sidebar_wrapper'; +import { Select } from 'ts/components/docs/sidebar/select'; + interface ITableOfContentsProps { contents: IContents[]; } @@ -19,9 +21,35 @@ export interface IContents { title: string; } +export interface ISelectItemConfig { + label: string; + value?: string; + onClick?: () => void; +} + +const items: ISelectItemConfig[] = [ + { + label: 'v6.1.10', + onClick: () => { + console.log('YEAH 10'); + }, + }, + { + label: 'v6.1.11', + onClick: () => { + console.log('YEAH 11'); + }, + }, +]; + +const onChange = () => { + console.log('ON CHANGE!'); +}; + export const TableOfContents: React.FC = ({ contents }) => { return ( +