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(IconButton): update public documentation + prop API [F36-1540] #2940

Merged
merged 5 commits into from
Nov 27, 2024

Conversation

cf-remylenoir
Copy link
Collaborator

@cf-remylenoir cf-remylenoir commented Nov 26, 2024

Purpose of PR

Updates the IconButton documentation and properties API description.

Updated documentation: https://forma-36-git-f36-1540-update-guidelines-for-icon-button.colorfuldemo.com/components/icon-button

PR Checklist

  • I have read the relevant readme.md file(s)
  • All commits follow our Git commit message convention
  • Tests are added/updated/not required
  • Tests are passing
  • Storybook stories are added/updated/not required
  • Usage notes are added/updated/not required
  • Has been tested based on Contentful's browser support
  • Doesn't contain any sensitive information

Copy link

changeset-bot bot commented Nov 26, 2024

🦋 Changeset detected

Latest commit: 73c9674

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

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

@cf-remylenoir cf-remylenoir self-assigned this Nov 26, 2024
Copy link

vercel bot commented Nov 26, 2024

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

Name Status Preview Updated (UTC)
forma-36 ✅ Ready (Inspect) Visit Preview Nov 27, 2024 2:23pm

@@ -43,7 +43,7 @@ interface PageContentHeaderProps {
const getGithubIssueLink = (title) => {
const queryParams = {
title: `💬 Feedback - ${title}`,
assignees: 'burakukula,mshaaban0,denkristoffer,Lelith',
assignees: 'Lelith, veu, cf-remylenoir, damann',
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We could replace the individuals with the team as soon as it is created.

Copy link
Collaborator Author

@cf-remylenoir cf-remylenoir Nov 27, 2024

Choose a reason for hiding this comment

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

It does not seem to be possible at the moment, see https://github.com/orgs/community/discussions/57306


In toolbars, action bars, and in all other space restricted containers we suggest using `IconButton` instead of `Button` component.
### Tooltip
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@damann I added the tooltip text you prepared in this section to include an example.

Copy link

github-actions bot commented Nov 26, 2024

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
CommonJS 112.03 KB (0%) 2.3 s (0%) 1.4 s (+5.91% 🔺) 3.6 s
Module 110.62 KB (0%) 2.3 s (0%) 1.6 s (+11.67% 🔺) 3.9 s

@cf-remylenoir cf-remylenoir requested review from veu and Lelith November 26, 2024 13:12
@cf-remylenoir cf-remylenoir marked this pull request as ready for review November 26, 2024 13:12
@cf-remylenoir cf-remylenoir requested review from damann and a team as code owners November 26, 2024 13:12
damann
damann previously approved these changes Nov 27, 2024
@cf-remylenoir cf-remylenoir requested a review from damann November 27, 2024 14:12
@cf-remylenoir cf-remylenoir dismissed damann’s stale review November 27, 2024 14:12

I updated the tooltip section

@cf-remylenoir cf-remylenoir merged commit 96c125c into main Nov 27, 2024
12 checks passed
@cf-remylenoir cf-remylenoir deleted the F36-1540-update-guidelines-for-icon-button branch November 27, 2024 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants