Skip to content

Introduces a PropsTable docs component #1671

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
Merged
merged 5 commits into from
Dec 3, 2021
Merged

Introduces a PropsTable docs component #1671

merged 5 commits into from
Dec 3, 2021

Conversation

jfuchs
Copy link
Contributor

@jfuchs jfuchs commented Nov 30, 2021

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
Copy link

changeset-bot bot commented Nov 30, 2021 •
edited
Loading

⚠️ 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
docs/content/TextInput.mdx
status: Alpha
---

import {PropsTable} from '../src/props-table'
Copy link
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

Copy link
Contributor Author

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
Copy link
Contributor

github-actions bot commented Nov 30, 2021 •
edited
Loading

size-limit report 📦

Path Size
dist/browser.esm.js 57.04 KB (0%)
dist/browser.umd.js 57.42 KB (0%)

colebemis
colebemis reviewed Nov 30, 2021
View reviewed changes
colebemis
colebemis reviewed Nov 30, 2021
View reviewed changes
@jfuchs jfuchs force-pushed the jfuchs/props-table-component branch from 11264b4 to 77e7395 Compare December 1, 2021 00:39
@jfuchs jfuchs changed the title WIP Introduces a PropsTable docs component Dec 1, 2021
@jfuchs jfuchs force-pushed the jfuchs/props-table-component branch from 77e7395 to f5e4d00 Compare December 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 mperrotti December 1, 2021 00:50
@jfuchs jfuchs added the skip changeset This change does not need a changelog label Dec 1, 2021
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
colebemis
colebemis reviewed Dec 1, 2021
View reviewed changes
@jfuchs
Copy link
Contributor Author

jfuchs commented Dec 2, 2021

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 jfuchs force-pushed the jfuchs/props-table-component branch from d9c61d9 to b018a91 Compare December 2, 2021 17:22
@jfuchs
Copy link
Contributor Author

jfuchs commented Dec 2, 2021

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

@jfuchs jfuchs force-pushed the jfuchs/props-table-component branch from 4680c5e to 34f1950 Compare December 3, 2021 00:12
colebemis
colebemis reviewed Dec 3, 2021
View reviewed changes
@jfuchs @colebemis
Update docs/content/TextInput.mdx
37fe275 
Co-authored-by: Cole Bemis <colebemis@github.com>
@jfuchs jfuchs force-pushed the jfuchs/props-table-component branch from 6458ff8 to 37fe275 Compare December 3, 2021 00:35
colebemis
colebemis approved these changes Dec 3, 2021
View reviewed changes
Copy link
Contributor

@colebemis colebemis left a comment

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 main Dec 3, 2021
@jfuchs jfuchs deleted the jfuchs/props-table-component branch December 3, 2021 04:47
@colebemis colebemis 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 free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@colebemis colebemis colebemis approved these changes

@mperrotti mperrotti Awaiting requested review from mperrotti

Assignees
No one assigned
Labels
skip changeset This 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