Document `data-*` attributes #407

bukinoshita · 2022-06-02T22:50:17Z

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code.
Include the URL where we can test the change in the body of your PR.

This pull request:

Fixes a bug
Adds additional features/functionality
Updates documentation or example code
Other

vercel · 2022-06-02T22:50:22Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
radix-website	✅ Ready (Inspect)	Visit Preview	Jun 15, 2022 at 7:25AM (UTC)

benoitgrelard · 2022-06-07T12:33:05Z

Hey @bukinoshita, just some quick early feedback on this:

it's looking awesome!
for those who are describing the value (non-discrete ones like "present when…") we should have them as text rather than code

vladmoroz · 2022-06-07T17:39:52Z

Have a few suggestions:

I think we need to remove the space between the prop and data attribute tables so it doesn't feel disjointed.
Our tables need a consistent layout, which is especially noticeable with props table and data attribute tables close to each other. I used width: 40% on the first column and width: 30% on the second and third columns in the examples below.

Before/after

bukinoshita · 2022-06-07T19:01:33Z

Have a few suggestions:

I think we need to remove the space between the prop and data attribute tables so it doesn't feel disjointed.

Our tables need a consistent layout, which is especially noticeable with props table and data attribute tables close to each other. I used width: 40% on the first column and width: 30% on the second and third columns in the examples below.

Before/after

Nice, this looks so much better!

bukinoshita · 2022-06-07T19:30:11Z

@benoitgrelard @vladmoroz Just updated!

benoitgrelard · 2022-06-08T14:28:16Z

This is awesome @bukinoshita, I noticed there are a few missing that are burried a bit inside the abstractions, hence why you might have missed them:

all components using Popper also get data-side, data-align on Content
all components using Menu gets the underlying data-state too on most parts

I can help go through together if you want.

Also I think your branch should target release instead as the base as there has been lots of changes in the docs since (probably new created versions, new parts on menus, etc)

Again, maybe easier if we go through together.

bukinoshita · 2022-06-08T14:34:25Z

This is awesome @bukinoshita, I noticed there are a few missing that are burried a bit inside the abstractions, hence why you might have missed them:

all components using Popper also get data-side, data-align on Content

all components using Menu gets the underlying data-state too on most parts

I can help go through together if you want.

Also I think your branch should target release instead as the base as there has been lots of changes in the docs since (probably new created versions, new parts on menus, etc)

Again, maybe easier if we go through together.

Yeah, let's go together in the remaining parts.

vladmoroz

Approved pending Benoît's comments

Catching up with merged features/fixes

benoitgrelard · 2022-06-13T13:34:52Z

data/primitives/components/context-menu/0.1.7.mdx

  ]}
 />

-<DataAttributesTable


This now exists since I've added it in a recent PR.

data/primitives/components/context-menu/0.1.7.mdx

data/primitives/components/dropdown-menu/0.1.7.mdx

benoitgrelard · 2022-06-14T08:01:25Z

data/primitives/overview/releases.mdx

 <PackageRelease name="Alert Dialog" version="0.0.20" major />

- [**Breaking**] Remove `AlertDialog.Content` `onPointerDownOutside` prop <PRLink id={700} />
+- [**Breaking**] Remove `AlertDialog.Content` `onPointerDownOutside` prop <PRLink id={700} />


What happened with this file? Looks like you have a different config maybe for spaces or something? 🤔

To be honest, I don't know. I getting a few changes locally after running yarn prettier on the files that I didn't change.

Ok maybe some rogue changes then.

data/primitives/components/context-menu/0.1.7.mdx

* Setup base PR * Initial documentation updates (#369) Catching up with merged features/fixes * Document `data-*` attributes * Document `data-*` * Fix spaces and render * Fix data * Document `data-*` attributes * Document `data-*` attributes * Add missing data attributes * Fix minor tweaks * Fix minor tweaks * Fix minor tweaks Co-authored-by: Benoît Grélard <benoit.grelard@gmail.com>

* Setup base PR * Initial documentation updates (#369) Catching up with merged features/fixes * Update release note for React 18 (#371) * Update release note for React 18 * Update data/primitives/overview/releases.mdx Co-authored-by: Benoît Grélard <benoit.grelard@gmail.com> Co-authored-by: Benoît Grélard <benoit.grelard@gmail.com> * Primitives 1344 documentation (#376) * Add new version pages * Remove references to `forwards` in new versions * Document NavigationMenu close on click 1347 (#380) * Document Select fix (#381) * Update `NavigationMenu` docs (#385) * Document Slot fix (#386) * Document Slot fix * PR feedback * Document latest menu/select updates (#387) * Document latest menu/select updates * Update 0.1.2.mdx * Update 0.1.2.mdx * Update 0.1.2.mdx * Add context menu note to release (#388) * Fix release note (#389) * Document ScrollArea animatable Thumb change (#390) * Remove enter key as per #393 * Document DismissableLayer fixes (#394) * Catchup on demo updates (#396) * Catchup on demo updates * Update data/primitives/components/select/0.1.2.mdx Co-authored-by: Andy Hook <hello@andyhook.dev> * PR feedback Co-authored-by: Andy Hook <hello@andyhook.dev> * Document tabs animation (#397) * Update file version/s * Update doc * Document submenu api change, `allowPinchZoom` prop move (#395) * Document submenu changes * Document `allowPinchZoom` prop change * Feedback * Document latest select fix (#398) * Document latest select fix * Update data/primitives/overview/releases.mdx Co-authored-by: Andy Hook <hello@andyhook.dev> Co-authored-by: Andy Hook <hello@andyhook.dev> * Document latest RadioGroup change (#399) * Document latest DismissableLayer change radix-ui/primitives#1423 * Sync files with recent changes (#412) * Document new Portal parts (#413) * Document new Portal parts * Document changes * Update demos * Update DeveloperExperienceSection.tsx * Document latest ContextMenu changes (#414) * Document latest Select changes (#415) * Document latest Select changes radix-ui/primitives#1459 * Add missing prop * Document latest Portal changes (#416) radix-ui/primitives#1463 * Parity in release branch from #417 (#419) #417 * Document `data-*` attributes (#407) * Setup base PR * Initial documentation updates (#369) Catching up with merged features/fixes * Document `data-*` attributes * Document `data-*` * Fix spaces and render * Fix data * Document `data-*` attributes * Document `data-*` attributes * Add missing data attributes * Fix minor tweaks * Fix minor tweaks * Fix minor tweaks Co-authored-by: Benoît Grélard <benoit.grelard@gmail.com> * Parity with #421 (#422) * Document toast animation improvements (#423) * Update release note * Label required, update package version * Document CSS variables (#426) * Document CSS variables * Change `Tooltip` CSS variable description * remove from slider * Fix `Accordion` CSS variable * Remove `ScrollArea` CSS variables * Update `transform-origin` description * Add `Toast` CSS variables better description * Fix `PropsTable` width * Fix minor tweaks * Fix minor tweaks * Apply copy suggestions * Fix minor tweaks * Fix minor tweaks * Fix minor tweaks * Update data/primitives/components/tooltip/0.1.8.mdx Co-authored-by: Andy Hook <hello@andyhook.dev> Co-authored-by: Benoît Grélard <benoit.grelard@gmail.com> Co-authored-by: Andy Hook <hello@andyhook.dev> * Document tooltip hover changes (#431) * Parity with #430 (#432) * Document `allowPinchZoom` changes (#433) * Document `allowPinchZoom` changes * Feedback * Release docs adjustments * Updating versions in log to v1 (for all hands purpose) * Copy change * Fix typo in `onSelect` desc and release note * Document popper changes (#437) * Update changelog * Document prop changes * Update demos with props * Update live demos * Add missing portals * Update deps * Revert "Update live demos" This reverts commit 981d20a. * Update deps * Update codesandbox css * Remove portal in marketing hero demos * Document new boundary prop * Missing changelog + add portal back on subs * PR feedback * PR feedback * Update stats (#438) * Update release to use 1.0.0 filenames (#439) * Shift breaking to first in change log * Move files to 1.0.0 * Upgrade DS version (#440) * Release refinement (#441) * Revert announce filename and deprecate * Update data-highlighted description * Release date consistency * Revert "Update data-highlighted description" This reverts commit 30b3ae1. * Tweak realease note order * Update release tags to major * Upgrade DS and primitives (#442) Co-authored-by: Andy Hook <hello@andyhook.dev> Co-authored-by: Bu Kinoshita <bukinoshita@gmail.com>

vercel bot deployed to Preview June 2, 2022 22:51 View deployment

vladmoroz self-requested a review June 3, 2022 10:19

vercel bot deployed to Preview June 6, 2022 19:53 View deployment

vercel bot deployed to Preview June 7, 2022 19:29 View deployment

bukinoshita marked this pull request as ready for review June 7, 2022 19:30

bukinoshita requested review from andy-hook and benoitgrelard as code owners June 7, 2022 19:30

vladmoroz approved these changes Jun 9, 2022

View reviewed changes

bukinoshita force-pushed the document-data-attributes branch from 667de63 to 39405a5 Compare June 10, 2022 14:43

vercel bot deployed to Preview June 10, 2022 14:46 View deployment

vercel bot deployed to Preview June 10, 2022 16:54 View deployment

benoitgrelard changed the base branch from main to release June 13, 2022 13:36

benoitgrelard and others added 8 commits June 13, 2022 10:50

Setup base PR

84d335d

Initial documentation updates (radix-ui#369)

18dfdcb

Catching up with merged features/fixes

Document data-* attributes

0aced89

Document data-*

ea797ea

Fix spaces and render

cc2145a

Fix data

da7d124

Document data-* attributes

7045af0

Document data-* attributes

186303b

bukinoshita force-pushed the document-data-attributes branch from 608edb8 to 186303b Compare June 13, 2022 13:59

vercel bot deployed to Preview June 13, 2022 14:20 View deployment

benoitgrelard reviewed Jun 14, 2022

View reviewed changes

Add missing data attributes

f452572

benoitgrelard reviewed Jun 14, 2022

View reviewed changes

data/primitives/components/context-menu/0.1.7.mdx Outdated Show resolved Hide resolved

data/primitives/components/context-menu/0.1.7.mdx Outdated Show resolved Hide resolved

vercel bot deployed to Preview June 14, 2022 14:03 View deployment

Fix minor tweaks

595be29

vercel bot deployed to Preview June 14, 2022 15:00 View deployment

Fix minor tweaks

af57a3a

vercel bot deployed to Preview June 14, 2022 15:08 View deployment

Fix minor tweaks

76355b0

bukinoshita requested a review from benoitgrelard June 15, 2022 07:24

vercel bot deployed to Preview June 15, 2022 07:25 View deployment

benoitgrelard approved these changes Jun 15, 2022

View reviewed changes

benoitgrelard merged commit 5e6ce61 into radix-ui:release Jun 15, 2022

bukinoshita deleted the document-data-attributes branch June 15, 2022 14:32

bukinoshita mentioned this pull request Jun 24, 2022

Document the available data-* attrs as part of the API reference for primitives #224

Closed

Document data-* attributes #407

Document data-* attributes #407

Uh oh!

Conversation

bukinoshita commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Jun 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benoitgrelard commented Jun 7, 2022

Uh oh!

vladmoroz commented Jun 7, 2022

Uh oh!

bukinoshita commented Jun 7, 2022

Uh oh!

bukinoshita commented Jun 7, 2022

Uh oh!

benoitgrelard commented Jun 8, 2022

Uh oh!

bukinoshita commented Jun 8, 2022

Uh oh!

vladmoroz left a comment

Choose a reason for hiding this comment

Uh oh!

benoitgrelard Jun 13, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benoitgrelard Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

bukinoshita Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

benoitgrelard Jun 14, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Document `data-*` attributes #407

Document `data-*` attributes #407

bukinoshita commented Jun 2, 2022 •

edited

Loading

vercel bot commented Jun 2, 2022 •

edited

Loading