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(tile) feature flag usage, style, code tab update #4266

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

laurenmrice
Copy link
Member

@laurenmrice laurenmrice commented Sep 18, 2024

Closes #4225

This PR updates the Tile component Usage, Style, and Code tabs to include feature flag information and images. The content on the Usage and Style tabs have also been updated with the new content templates.

Note: Links in various places to the "Feature Flag tab" have not been updated yet, because that page is not live yet.


Changelog

New

Usage:

  • Page tag
  • Content
  • Images

Style:

  • Content
  • Images

Code:

  • Resource card tag
  • Content

Changed

  • Content and images

Removed

  • Images and content that needed to be taken out

Copy link

vercel bot commented Sep 18, 2024

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

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 20, 2024 4:40pm

Copy link
Member

@thyhmdo thyhmdo left a comment

Choose a reason for hiding this comment

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

This looks awesome with so many details! Just my 1st take on reviewing this doc with some comments

- The `enable-experimental-tile-contrast` flag adds a border to the tile with
improved contrast for accessibility and to visually indicate they are
operable.
- The `enable-v12-tile-default-icons` flag enables the rendering of default
Copy link
Member

Choose a reason for hiding this comment

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

This seems like a run-on sentence. Here's a suggestion.

Suggested change
- The `enable-v12-tile-default-icons` flag enables the rendering of default
- The `enable-v12-tile-default-icons` flag enables the rendering of default icons on the clickable variant of a tile, such as the ArrowRight icon for navigation or the Error icon when the tile is disabled. If the user hasn't configured a different icon, these defaults will be used.

Copy link
Member

Choose a reason for hiding this comment

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

sections below.
1. **Container**: Contains all content within a tile.
2. **Text**: The text within a tile.
3. **Icon**: The icon that visually indicates the tile is selectable.
Copy link
Member

Choose a reason for hiding this comment

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

Clarify that this could be either the checkbox or the radio button icon.

Copy link
Member

Choose a reason for hiding this comment

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

The enabled image appears to be smaller/slightly different position than the featured flag disabled one

Copy link
Member

Choose a reason for hiding this comment

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

Just check on two images Feature enabled and feature-enabled positions.

Copy link
Member

Choose a reason for hiding this comment

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

Just check on the Link position in both Hover images

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Flags] Tile: add feature flag content to Usage, Style, and Code tabs
2 participants