Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(vx-glyph): update to codegen #705

Merged
merged 2 commits into from
May 22, 2020
Merged

docs(vx-glyph): update to codegen #705

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cebdf42
docs(vx-glyph): update to codegen
williaster May 13, 2020
7a8e746
docs(vx-glyph): fix component sort order
williaster May 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/vx-demo/src/components/PackageList.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ export default function PackageList({
{!compact && <p>d3 line interpolators for @vx/shape</p>}
</li>
<li className={cx(emphasizePackage === 'glyph' && 'emphasize')}>
<a href="/static/docs/vx-glyph.html">@vx/glyph</a>
{!compact && <p>Complex marks & symbols</p>}
<a href="/docs/glyph">@vx/glyph</a>
{!compact && <p>Complex marks & symbols to be used in visuals</p>}
</li>
<li className={cx(emphasizePackage === 'grid' && 'emphasize')}>
<a href="/static/docs/vx-grid.html">@vx/grid</a>
Expand Down
13 changes: 13 additions & 0 deletions packages/vx-demo/src/pages/docs/Glyph.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import React from 'react';
import GlyphReadme from '!!raw-loader!../../../../vx-glyph/Readme.md';
import * as Glyph from '../../../../vx-glyph/src';
import DocPage from '../../components/DocPage';
import { DocGenInfo } from '../../types';

const components = (Object.values(Glyph).map(
component =>
// @ts-ignore
component.__docgenInfo,
) as DocGenInfo[]).sort((a, b) => a.displayName.localeCompare(b.displayName));

export default () => <DocPage components={components} readme={GlyphReadme} vxPackage="glyph" />;
139 changes: 0 additions & 139 deletions packages/vx-demo/src/static/docs/vx-glyph.html
View file
Open in desktop

This file was deleted.

145 changes: 2 additions & 143 deletions packages/vx-glyph/Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,152 +4,11 @@
<img src="https://img.shields.io/npm/dm/@vx/glyph.svg?style=flat-square" />
</a>

Glyphs are small icons that you can use in your graphs. Example: [https://vx-demo.now.sh/glyphs](https://vx-demo.now.sh/glyphs)

Glyphs are small marks or symbols that you can use in your charts. Example:
[https://vx-demo.now.sh/glyphs](https://vx-demo.now.sh/glyphs)

## Installation

```
npm install --save @vx/glyph
```


## Components



- [Glyph](#glyph-)
- [GlyphCircle](#glyphcircle-)
- [GlyphCross](#glyphcross-)
- [GlyphDiamond](#glyphdiamond-)
- [GlyphDot](#glyphdot-)
- [GlyphSquare](#glyphsquare-)
- [GlyphStar](#glyphstar-)
- [GlyphTriangle](#glyphtriangle-)
- [GlyphWye](#glyphwye-)

## API



<h3 id="glyph-">&lt;Glyph /&gt;</h3>



<a id="#Glyph__children" name="Glyph__children" href="#Glyph__children">#</a> *Glyph*.**children**&lt;any&gt;

<a id="#Glyph__className" name="Glyph__className" href="#Glyph__className">#</a> *Glyph*.**className**&lt;string&gt;

<a id="#Glyph__left" name="Glyph__left" href="#Glyph__left">#</a> *Glyph*.**left**&lt;number&gt; <table><tr><td><strong>Default</strong></td><td>0</td></td></table>

<a id="#Glyph__top" name="Glyph__top" href="#Glyph__top">#</a> *Glyph*.**top**&lt;number&gt; <table><tr><td><strong>Default</strong></td><td>0</td></td></table>

<h3 id="glyphcircle-">&lt;GlyphCircle /&gt;</h3>



<a id="#GlyphCircle__children" name="GlyphCircle__children" href="#GlyphCircle__children">#</a> *GlyphCircle*.**children**&lt;func&gt;

<a id="#GlyphCircle__className" name="GlyphCircle__className" href="#GlyphCircle__className">#</a> *GlyphCircle*.**className**&lt;string&gt;

<a id="#GlyphCircle__left" name="GlyphCircle__left" href="#GlyphCircle__left">#</a> *GlyphCircle*.**left**&lt;number&gt;

<a id="#GlyphCircle__size" name="GlyphCircle__size" href="#GlyphCircle__size">#</a> *GlyphCircle*.**size**&lt;union(number|func)&gt;

<a id="#GlyphCircle__top" name="GlyphCircle__top" href="#GlyphCircle__top">#</a> *GlyphCircle*.**top**&lt;number&gt;

<h3 id="glyphcross-">&lt;GlyphCross /&gt;</h3>



<a id="#GlyphCross__children" name="GlyphCross__children" href="#GlyphCross__children">#</a> *GlyphCross*.**children**&lt;func&gt;

<a id="#GlyphCross__className" name="GlyphCross__className" href="#GlyphCross__className">#</a> *GlyphCross*.**className**&lt;string&gt;

<a id="#GlyphCross__left" name="GlyphCross__left" href="#GlyphCross__left">#</a> *GlyphCross*.**left**&lt;number&gt;

<a id="#GlyphCross__size" name="GlyphCross__size" href="#GlyphCross__size">#</a> *GlyphCross*.**size**&lt;union(number|func)&gt;

<a id="#GlyphCross__top" name="GlyphCross__top" href="#GlyphCross__top">#</a> *GlyphCross*.**top**&lt;number&gt;

<h3 id="glyphdiamond-">&lt;GlyphDiamond /&gt;</h3>



<a id="#GlyphDiamond__children" name="GlyphDiamond__children" href="#GlyphDiamond__children">#</a> *GlyphDiamond*.**children**&lt;func&gt;

<a id="#GlyphDiamond__className" name="GlyphDiamond__className" href="#GlyphDiamond__className">#</a> *GlyphDiamond*.**className**&lt;string&gt;

<a id="#GlyphDiamond__left" name="GlyphDiamond__left" href="#GlyphDiamond__left">#</a> *GlyphDiamond*.**left**&lt;number&gt;

<a id="#GlyphDiamond__size" name="GlyphDiamond__size" href="#GlyphDiamond__size">#</a> *GlyphDiamond*.**size**&lt;union(number|func)&gt;

<a id="#GlyphDiamond__top" name="GlyphDiamond__top" href="#GlyphDiamond__top">#</a> *GlyphDiamond*.**top**&lt;number&gt;

<h3 id="glyphdot-">&lt;GlyphDot /&gt;</h3>



<a id="#GlyphDot__children" name="GlyphDot__children" href="#GlyphDot__children">#</a> *GlyphDot*.**children**&lt;func&gt;

<a id="#GlyphDot__className" name="GlyphDot__className" href="#GlyphDot__className">#</a> *GlyphDot*.**className**&lt;string&gt;

<a id="#GlyphDot__left" name="GlyphDot__left" href="#GlyphDot__left">#</a> *GlyphDot*.**left**&lt;number&gt; <table><tr><td><strong>Default</strong></td><td>0</td></td></table>

<a id="#GlyphDot__top" name="GlyphDot__top" href="#GlyphDot__top">#</a> *GlyphDot*.**top**&lt;number&gt; <table><tr><td><strong>Default</strong></td><td>0</td></td></table>

<h3 id="glyphsquare-">&lt;GlyphSquare /&gt;</h3>



<a id="#GlyphSquare__children" name="GlyphSquare__children" href="#GlyphSquare__children">#</a> *GlyphSquare*.**children**&lt;func&gt;

<a id="#GlyphSquare__className" name="GlyphSquare__className" href="#GlyphSquare__className">#</a> *GlyphSquare*.**className**&lt;string&gt;

<a id="#GlyphSquare__left" name="GlyphSquare__left" href="#GlyphSquare__left">#</a> *GlyphSquare*.**left**&lt;number&gt;

<a id="#GlyphSquare__size" name="GlyphSquare__size" href="#GlyphSquare__size">#</a> *GlyphSquare*.**size**&lt;union(number|func)&gt;

<a id="#GlyphSquare__top" name="GlyphSquare__top" href="#GlyphSquare__top">#</a> *GlyphSquare*.**top**&lt;number&gt;

<h3 id="glyphstar-">&lt;GlyphStar /&gt;</h3>



<a id="#GlyphStar__children" name="GlyphStar__children" href="#GlyphStar__children">#</a> *GlyphStar*.**children**&lt;func&gt;

<a id="#GlyphStar__className" name="GlyphStar__className" href="#GlyphStar__className">#</a> *GlyphStar*.**className**&lt;string&gt;

<a id="#GlyphStar__left" name="GlyphStar__left" href="#GlyphStar__left">#</a> *GlyphStar*.**left**&lt;number&gt;

<a id="#GlyphStar__size" name="GlyphStar__size" href="#GlyphStar__size">#</a> *GlyphStar*.**size**&lt;union(number|func)&gt;

<a id="#GlyphStar__top" name="GlyphStar__top" href="#GlyphStar__top">#</a> *GlyphStar*.**top**&lt;number&gt;

<h3 id="glyphtriangle-">&lt;GlyphTriangle /&gt;</h3>



<a id="#GlyphTriangle__children" name="GlyphTriangle__children" href="#GlyphTriangle__children">#</a> *GlyphTriangle*.**children**&lt;func&gt;

<a id="#GlyphTriangle__className" name="GlyphTriangle__className" href="#GlyphTriangle__className">#</a> *GlyphTriangle*.**className**&lt;string&gt;

<a id="#GlyphTriangle__left" name="GlyphTriangle__left" href="#GlyphTriangle__left">#</a> *GlyphTriangle*.**left**&lt;number&gt;

<a id="#GlyphTriangle__size" name="GlyphTriangle__size" href="#GlyphTriangle__size">#</a> *GlyphTriangle*.**size**&lt;union(number|func)&gt;

<a id="#GlyphTriangle__top" name="GlyphTriangle__top" href="#GlyphTriangle__top">#</a> *GlyphTriangle*.**top**&lt;number&gt;

<h3 id="glyphwye-">&lt;GlyphWye /&gt;</h3>



<a id="#GlyphWye__children" name="GlyphWye__children" href="#GlyphWye__children">#</a> *GlyphWye*.**children**&lt;func&gt;

<a id="#GlyphWye__className" name="GlyphWye__className" href="#GlyphWye__className">#</a> *GlyphWye*.**className**&lt;string&gt;

<a id="#GlyphWye__left" name="GlyphWye__left" href="#GlyphWye__left">#</a> *GlyphWye*.**left**&lt;number&gt;

<a id="#GlyphWye__size" name="GlyphWye__size" href="#GlyphWye__size">#</a> *GlyphWye*.**size**&lt;union(number|func)&gt;

<a id="#GlyphWye__top" name="GlyphWye__top" href="#GlyphWye__top">#</a> *GlyphWye*.**top**&lt;number&gt;
Loading