Skip to content

Commit

Permalink
Add styling info to Explorer Readme (#687)
Browse files Browse the repository at this point in the history
* update readme with styling note

* version patch

* regen docs
  • Loading branch information
danmarshall authored Oct 31, 2023
1 parent d90071c commit 7ac31e0
Show file tree
Hide file tree
Showing 7 changed files with 81 additions and 55 deletions.
98 changes: 49 additions & 49 deletions docs/docs/sanddance-explorer/v4/classes/Explorer_Class.html

Large diffs are not rendered by default.

13 changes: 13 additions & 0 deletions docs/docs/sanddance-explorer/v4/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,19 @@ <h2>Installation</h2>
<span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #0000FF">*</span><span style="color: #000000"> </span><span style="color: #AF00DB">as</span><span style="color: #000000"> </span><span style="color: #001080">ReactDOM</span><span style="color: #000000"> </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;react-dom&#039;</span><span style="color: #000000">;</span>
<span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Explorer</span><span style="color: #000000">, </span><span style="color: #001080">use</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@msrvida/sanddance-explorer&#039;</span><span style="color: #000000">;</span>

<span style="color: #008000">//quickstart: use the included stylesheet</span>
<span style="color: #AF00DB">import</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;@msrvida/sanddance-explorer/dist/css/sanddance-explorer.css&quot;</span>

<span style="color: #008000">/*</span>
<span style="color: #008000"> in your own stylesheet, you can modify the sanddance-explorer class to fit your needs.</span>
<span style="color: #008000"> Example:</span>

<span style="color: #008000">.sanddance-explorer {</span>
<span style="color: #008000"> height: 800px;</span>
<span style="color: #008000">}</span>

<span style="color: #008000">*/</span>

<span style="color: #001080">fluentui</span><span style="color: #000000">.</span><span style="color: #795E26">initializeIcons</span><span style="color: #000000">();</span>

<span style="color: #795E26">use</span><span style="color: #000000">(</span><span style="color: #001080">fluentui</span><span style="color: #000000">, </span><span style="color: #001080">React</span><span style="color: #000000">, </span><span style="color: #001080">ReactDOM</span><span style="color: #000000">, </span><span style="color: #001080">vega</span><span style="color: #000000">);</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> key</h3>
<aside class="tsd-sources">
<p>Inherited from FluentUITypes.IDialogProps.key</p>
<ul>
<li>Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:130</li>
<li>Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:129</li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -547,7 +547,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> ref</h3>
<aside class="tsd-sources">
<p>Inherited from FluentUITypes.IDialogProps.ref</p>
<ul>
<li>Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:136</li>
<li>Defined in fluentui-react-cdn-typings/node_modules/@types/react/index.d.ts:135</li>
</ul>
</aside>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/sanddance-explorer/v4/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ <h3><span class="tsd-flag ts-flagConst">Const</span> Explorer</h3>
<div class="tsd-signature tsd-kind-icon">Explorer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="classes/Explorer_Class.html" class="tsd-signature-type" data-tsd-kind="Class">Explorer_Class</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/explorer.tsx#L1557">sanddance-explorer/src/explorer.tsx:1557</a></li>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-explorer/src/explorer.tsx#L1558">sanddance-explorer/src/explorer.tsx:1558</a></li>
</ul>
</aside>
</section>
Expand Down
13 changes: 13 additions & 0 deletions packages/sanddance-explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,19 @@ import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { Explorer, use } from '@msrvida/sanddance-explorer';

//quickstart: use the included stylesheet
import "@msrvida/sanddance-explorer/dist/css/sanddance-explorer.css"

/*
in your own stylesheet, you can modify the sanddance-explorer class to fit your needs.
Example:
.sanddance-explorer {
height: 800px;
}
*/

fluentui.initializeIcons();

use(fluentui, React, ReactDOM, vega);
Expand Down
4 changes: 2 additions & 2 deletions packages/sanddance-explorer/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/sanddance-explorer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@msrvida/sanddance-explorer",
"version": "4.1.6",
"version": "4.1.7",
"description": "SandDance data exploration React component.",
"main": "dist/es6/index.js",
"repository": {
Expand Down

0 comments on commit 7ac31e0

Please sign in to comment.