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.

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

docs: added props generation script #160

Merged
merged 33 commits into from
Nov 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
47b47c9
chore(accordion): refactored & cleaned up accordion types (#153)
anuraghazra Nov 17, 2020
783e946
test(select): added select tests (#154)
anuraghazra Nov 18, 2020
4d7e08f
chore: wip prop generation
anuraghazra Nov 19, 2020
5b7921c
docs: fixed props types generator script
anuraghazra Nov 19, 2020
de77884
chore: removed redundant utils code
anuraghazra Nov 19, 2020
94aff8f
chore: outdent template strings
anuraghazra Nov 19, 2020
b048f28
chore: unify getJsDocs function
anuraghazra Nov 19, 2020
53a7523
chore: added inject-md-content script
anuraghazra Nov 19, 2020
567b4c2
docs: run docsgen:example & docsgen:props
anuraghazra Nov 19, 2020
03db74d
build(props-docgen): 🐛 fix rangecalendar types
navin-moorthy Nov 19, 2020
220bcc9
chore: accordion types reorder
anuraghazra Nov 19, 2020
b358c1d
Merge branch 'docs-gen-props' of https://github.com/timelessco/render…
anuraghazra Nov 19, 2020
80e6deb
chore: run prettier on markdown
anuraghazra Nov 19, 2020
7b34ded
chore: fixed perttier not working
anuraghazra Nov 19, 2020
8e5fdea
docs: added composition generation script
anuraghazra Nov 20, 2020
d732f95
docs: added prettify script and run once
anuraghazra Nov 20, 2020
17aa3ef
refactor: refactored inject prop script
anuraghazra Nov 20, 2020
57a3434
chore(accordion): 🏷️ update type declaration for prop generation (#163)
navin-moorthy Nov 20, 2020
180f026
Merge branch 'master' into docs-gen-props
anuraghazra Nov 20, 2020
517e540
Merge branch 'docs-gen-props' of https://github.com/timelessco/render…
anuraghazra Nov 20, 2020
ba1a4c5
chore: regenerate docs
anuraghazra Nov 20, 2020
b2757b2
docs: added codesandbox link generation script
anuraghazra Nov 20, 2020
e09975e
docs: improve sandbox script to add short sandbox url
anuraghazra Nov 20, 2020
16e9075
docs: hardcode reakit dep & fixed extraDep
anuraghazra Nov 20, 2020
8c6db12
docs(calendar): 📝 update jsdocs for the calendar (#166)
navin-moorthy Nov 20, 2020
ecb6ada
docs: added calendar sandbox link
anuraghazra Nov 20, 2020
a8eb1a5
docs: added link_title support for csblinks generation
anuraghazra Nov 23, 2020
e3272ed
docs: added support for multiple csb links
anuraghazra Nov 23, 2020
5ecf482
chore: rename fsUtils to fs-utils
anuraghazra Nov 23, 2020
fe06ad1
docs: added links in main readme
anuraghazra Nov 23, 2020
7a38579
fix(docs): refactored & fixed multiple sandbox link generation
anuraghazra Nov 23, 2020
a77a878
docs: fix csblinks path & regenerate docs
anuraghazra Nov 23, 2020
65a07b8
chore: renamed generate-docs to inject-examples & better chalk logs
anuraghazra Nov 23, 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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,12 @@ below documentation to learn more.

## Components

- [Accordion](#accordion)
- Breadcrumbs
- Calendar
- [Accordion](./docs/Accordion.md)
- [Breadcrumbs](./docs/Breadcrumb.md)
- [Calendar](./docs/Calendar.md)
- Date Picker
- Drawer
- Link
- [Link](./docs/Link.md)
- Meter
- Number Input
- Pagination
Expand Down
19 changes: 11 additions & 8 deletions docs-templates/Accordion.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
Accessible Accordion component. It follows the
[WAI-ARIA Accordion Pattern](https://www.w3.org/TR/wai-aria-practices-1.2/#accordion).

<!-- CODESANDBOX
link_title: Accordion Example Live Demo
js: src/accordion/stories/__js/AccordionBasic.component.jsx
css: src/accordion/stories/AccordionStyled.css
-->

# Props

<!-- INJECT_PROPS src/accordion -->

### Accessibility

- `Accordion` extends the accessibility features of
Expand All @@ -22,17 +32,10 @@ Accessible Accordion component. It follows the

### Composition

- `Accordion` uses
[Composite](https://github.com/reakit/reakit/blob/master/docs/composite).
- `AccordionTrigger` uses
[CompositeItem](https://github.com/reakit/reakit/blob/master/docs/composite).
- `AccordionPanel` uses
[DisclosureContent](https://github.com/reakit/reakit/blob/master/docs/disclosure).
<!-- INJECT_COMPOSITION src/accordion -->

### Example

```js

<!-- IMPORT_EXAMPLE src/accordion/stories/__js/AccordionBasic.component.jsx -->

```
8 changes: 5 additions & 3 deletions docs-templates/Breadcrumb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ Accessible `Breadcrumb` component that provides the required aria attributes for
it's links. It follows the
[WAI-ARIA Breadcrumb Pattern](https://www.w3.org/TR/wai-aria-practices-1.2/#breadcrumb).

# Props

<!-- INJECT_PROPS src/breadcrumbs -->

### Accessibilty

- `Breadcrumbs` should have `aria-label` or `aria-labelledby` attribute.
Expand All @@ -13,12 +17,10 @@ it's links. It follows the

### Composition

- `BreadcrumbLink` uses [Link](#Link).
<!-- INJECT_COMPOSITION src/breadcrumbs -->

### Example

```js

<!-- IMPORT_EXAMPLE src/breadcrumbs/stories/__js/Breadcrumbs.component.jsx -->

```
37 changes: 37 additions & 0 deletions docs-templates/Calendar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## Calendar

Accessible `Calendar` component.

<!-- CODESANDBOX
link_title: Calendar - Open On Sandbox
js: src/calendar/stories/__js/CalendarBase.component.jsx
css: src/calendar/stories/CalendarBase.css
-->

<!-- CODESANDBOX
link_title: RangeCalendar - Open On Sandbox
js: src/calendar/stories/__js/CalendarRange.component.jsx
css: src/calendar/stories/CalendarRange.css
-->

# Props

<!-- INJECT_PROPS src/calendar -->

# Composition

<!-- INJECT_COMPOSITION src/calendar -->

### Example

#### Base Calendar

```js
<!-- IMPORT_EXAMPLE src/calendar/stories/__js/CalendarBase.component.jsx -->
```

#### Range Calendar

```js
<!-- IMPORT_EXAMPLE src/calendar/stories/__js/CalendarRange.component.jsx -->
```
9 changes: 5 additions & 4 deletions docs-templates/Link.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@ Accessible `Link` component that provides the required aria role when used under
different compositions. It follows the
[WAI-ARIA Link Pattern](https://www.w3.org/TR/wai-aria-practices-1.2/#link).

# Props

<!-- INJECT_PROPS src/link -->

### Accessibilty

- `Link` has role `link`.

### Composition

- `Link` uses
[Clickable](https://github.com/reakit/reakit/blob/master/docs/clickable)
<!-- INJECT_COMPOSITION src/link -->

### Example

```js

<!-- IMPORT_EXAMPLE src/link/stories/__js/Link.component.jsx -->

```
Loading