Skip to content

Introduces a PropsTable docs component - #1671

Merged
jfuchs merged 5 commits into
mainfrom
jfuchs/props-table-component
Dec 3, 2021
Merged

Introduces a PropsTable docs component#1671
jfuchs merged 5 commits into
mainfrom
jfuchs/props-table-component

Conversation

@jfuchs

@jfuchsjfuchs commented Nov 30, 2021

Copy link
Copy Markdown
Contributor

Describe your changes here.

Closes # (type the issue number after # if applicable; otherwise remove this line)

Screenshots

Please provide before/after screenshots for any visual changes

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@changeset-bot

changeset-botBot commented Nov 30, 2021•
edited
Loading

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 37fe275

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

colebemis
colebemis reviewed Nov 30, 2021
View reviewed changes
Comment threaddocs/content/TextInput.mdx
status: Alpha
---

import {PropsTable} from '../src/props-table'

@colebemiscolebemisNov 30, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can make PropsTable globally available in markdown files by exporting it here: https://github.com/primer/react/blob/main/docs/src/%40primer/gatsby-theme-doctocat/mdx-components.js

@jfuchsjfuchsNov 30, 2021

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like when I try that, I get this error:

CleanShot 2021-11-30 at 14 52 53@2x

@github-actions

github-actionsBot commented Nov 30, 2021•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
dist/browser.esm.js57.04 KB (0%)
dist/browser.umd.js57.42 KB (0%)

colebemis
colebemis reviewed Nov 30, 2021
View reviewed changes
Comment threaddocs/content/TextInput.mdx
colebemis
colebemis reviewed Nov 30, 2021
View reviewed changes
Comment threaddocs/content/TextInput.mdx
@jfuchs
jfuchsforce-pushed the jfuchs/props-table-component branch from 11264b4 to 77e7395CompareDecember 1, 2021 00:39
@jfuchsjfuchs changed the title WIPIntroduces a PropsTable docs componentDec 1, 2021
@jfuchs
jfuchsforce-pushed the jfuchs/props-table-component branch from 77e7395 to f5e4d00CompareDecember 1, 2021 00:46
@jfuchs
jfuchs marked this pull request as ready for review December 1, 2021 00:50
@jfuchs
jfuchs requested review from a team and mperrottiDecember 1, 2021 00:50
@jfuchsjfuchs added the skip changeset This change does not need a changelog label Dec 1, 2021
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
Comment threaddocs/src/props-table.js Outdated
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
Comment threaddocs/src/props-table.js Outdated
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
Comment threaddocs/src/props-table.js Outdated
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
Comment threaddocs/content/Link.mdx Outdated
@jfuchs

jfuchs commented Dec 2, 2021

Copy link
Copy Markdown
ContributorAuthor

I'm experimenting more with what Link's props table could be, since it ticks all the boxes for our common props:

CleanShot 2021-12-01 at 16 57 29@2x

@jfuchs
jfuchsforce-pushed the jfuchs/props-table-component branch from d9c61d9 to b018a91CompareDecember 2, 2021 17:22
@jfuchs

jfuchs commented Dec 2, 2021

Copy link
Copy Markdown
ContributorAuthor

Another shot at a succinct explanation of DOM/passthrough props:
CleanShot 2021-12-02 at 10 15 21@2x

@jfuchs
jfuchsforce-pushed the jfuchs/props-table-component branch from 4680c5e to 34f1950CompareDecember 3, 2021 00:12
colebemis
colebemis reviewed Dec 3, 2021
View reviewed changes
Comment threaddocs/content/TextInput.mdx Outdated
@jfuchs@colebemis
Update docs/content/TextInput.mdx
37fe275
Co-authored-by: Cole Bemis <colebemis@github.com>
@jfuchs
jfuchsforce-pushed the jfuchs/props-table-component branch from 6458ff8 to 37fe275CompareDecember 3, 2021 00:35
colebemis
colebemis approved these changes Dec 3, 2021
View reviewed changes

@colebemiscolebemis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 🚢 🚢

@jfuchs
jfuchs merged commit 70b2f70 into mainDec 3, 2021
@jfuchs
jfuchs deleted the jfuchs/props-table-component branch December 3, 2021 04:47
@colebemiscolebemis mentioned this pull request Dec 6, 2021
Closed
59 tasks
pksjce pushed a commit that referenced this pull request Dec 20, 2021
@jfuchs@colebemis@pksjce
Introduces a PropsTable docs component (#1671)
0596499
* Introduces a PropsTable docs component
* Update docs/content/Link.mdx
Co-authored-by: Cole Bemis <colebemis@github.com>
* more iteration
* Continued iteration with @colebemis.
* Update docs/content/TextInput.mdx
Co-authored-by: Cole Bemis <colebemis@github.com>
Co-authored-by: Cole Bemis <colebemis@github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mperrottimperrottiAwaiting requested review from mperrotti
1 more reviewer
@colebemiscolebemiscolebemis approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

skip changesetThis change does not need a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jfuchs@colebemis