From 0e88b30da60fa9627b155830fd5cc998522ab750 Mon Sep 17 00:00:00 2001 From: "Jules Sam. Randolph" Date: Thu, 1 Oct 2020 08:46:50 -0300 Subject: [PATCH] docs: add TableStyleSpecs image in various places --- docs/table-plugin.defaulttablestylesspecs.md | 2 ++ docs/table-plugin.md | 4 ++-- docs/table-plugin.tableconfig.md | 2 +- docs/table-plugin.tableconfig.tablestylespecs.md | 2 ++ docs/table-plugin.tablestylespecs.md | 2 +- table-plugin/src/css-rules.ts | 2 ++ table-plugin/src/types.ts | 4 +++- 7 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/table-plugin.defaulttablestylesspecs.md b/docs/table-plugin.defaulttablestylesspecs.md index 9af366c..91f4321 100644 --- a/docs/table-plugin.defaulttablestylesspecs.md +++ b/docs/table-plugin.defaulttablestylesspecs.md @@ -6,6 +6,8 @@ Default styles attributes. + + Signature: ```typescript diff --git a/docs/table-plugin.md b/docs/table-plugin.md index f39a7c6..9d1a6ce 100644 --- a/docs/table-plugin.md +++ b/docs/table-plugin.md @@ -24,13 +24,13 @@ | [TableAccurateContentHeightState](./table-plugin.tableaccuratecontentheightstate.md) | This content height state appears when the real table height is available, after the DOM has been mounted in the WebView. | | [TableConfig](./table-plugin.tableconfig.md) | This object defines how the table component can be customized. | | [TableHeuristicContentHeightState](./table-plugin.tableheuristiccontentheightstate.md) | This content height state is available on mount, before the real height is known from the DOM. | -| [TableStyleSpecs](./table-plugin.tablestylespecs.md) | An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md).!\[\](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png) | +| [TableStyleSpecs](./table-plugin.tablestylespecs.md) | An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md). | ## Variables | Variable | Description | | --- | --- | -| [defaultTableStylesSpecs](./table-plugin.defaulttablestylesspecs.md) | Default styles attributes. | +| [defaultTableStylesSpecs](./table-plugin.defaulttablestylesspecs.md) | Default styles attributes. | | [IGNORED\_TAGS](./table-plugin.ignored_tags.md) | A new list of tags to ignore, which exclude [TABLE\_TAGS](./table-plugin.table_tags.md). | | [TABLE\_TAGS](./table-plugin.table_tags.md) | All HTML tags associated with a table element. | diff --git a/docs/table-plugin.tableconfig.md b/docs/table-plugin.tableconfig.md index 924f2e6..65009f5 100644 --- a/docs/table-plugin.tableconfig.md +++ b/docs/table-plugin.tableconfig.md @@ -23,7 +23,7 @@ export interface TableConfig | [cssRules](./table-plugin.tableconfig.cssrules.md) | string | Override default CSS rules with this prop. | | [sourceBaseUrl](./table-plugin.tableconfig.sourcebaseurl.md) | string | See https://git.io/JeCAG | | [style](./table-plugin.tableconfig.style.md) | StyleProp<ViewStyle> | Container style. | -| [tableStyleSpecs](./table-plugin.tableconfig.tablestylespecs.md) | [TableStyleSpecs](./table-plugin.tablestylespecs.md) | Specs to generate css rules. | +| [tableStyleSpecs](./table-plugin.tableconfig.tablestylespecs.md) | [TableStyleSpecs](./table-plugin.tablestylespecs.md) | Specs to generate css rules. | | [WebView](./table-plugin.tableconfig.webview.md) | ComponentType<WebViewProps> | The WebView Component you wish to use. | | [webViewProps](./table-plugin.tableconfig.webviewprops.md) | WebViewProps | Any props you'd like to pass to [TableConfig.WebView](./table-plugin.tableconfig.webview.md). | diff --git a/docs/table-plugin.tableconfig.tablestylespecs.md b/docs/table-plugin.tableconfig.tablestylespecs.md index 181ab07..49716c3 100644 --- a/docs/table-plugin.tableconfig.tablestylespecs.md +++ b/docs/table-plugin.tableconfig.tablestylespecs.md @@ -6,6 +6,8 @@ Specs to generate css rules. + + Signature: ```typescript diff --git a/docs/table-plugin.tablestylespecs.md b/docs/table-plugin.tablestylespecs.md index 0ba2ab7..15742a5 100644 --- a/docs/table-plugin.tablestylespecs.md +++ b/docs/table-plugin.tablestylespecs.md @@ -6,7 +6,7 @@ An object describing how to generate styles. See [cssRulesFromSpecs()](./table-plugin.cssrulesfromspecs.md). -!\[\](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png) + Signature: diff --git a/table-plugin/src/css-rules.ts b/table-plugin/src/css-rules.ts index b8ba31b..2fbf72a 100644 --- a/table-plugin/src/css-rules.ts +++ b/table-plugin/src/css-rules.ts @@ -3,6 +3,8 @@ import { TableStyleSpecs } from './types'; /** * Default styles attributes. * + * + * * @remarks * Custom attributes will be shallow-merged. * diff --git a/table-plugin/src/types.ts b/table-plugin/src/types.ts index de7be72..285b2e4 100644 --- a/table-plugin/src/types.ts +++ b/table-plugin/src/types.ts @@ -4,7 +4,7 @@ import { StyleProp, ViewStyle } from 'react-native'; /** * An object describing how to generate styles. See {@link cssRulesFromSpecs}. * - * ![](https://raw.githubusercontent.com/native-html/table-plugin/master/images/TableStyleSpecs.png) + * * * @public */ @@ -239,6 +239,8 @@ export interface TableConfig { /** * Specs to generate css rules. * + * + * * @remarks * This prop will be ignored when `cssRules` are provided. */