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: Update ColorPallete and example #28741

Merged
merged 4 commits into from
Jul 29, 2024
Merged

Conversation

aberllin
Copy link
Contributor

@aberllin aberllin commented Jul 29, 2024

What I did

  • Updated documentation to include support for gradients in ColorItem.
  • Mentioned examples of valid gradient formats such as 'linear-gradient(to right, white, black)' and 'linear-gradient(65deg, white, black)'.

Related to the issue: #10232

Documentation

  • Add or update documentation reflecting your changes

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

- Updated documentation to include support for gradients in ColorItem.
- Mentioned examples of valid gradient formats such as 'linear-gradient(to right, white, black)' and 'linear-gradient(65deg, white, black)'.
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

LGTM

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

@jonniebigodes jonniebigodes self-assigned this Jul 29, 2024
@jonniebigodes jonniebigodes changed the title Update doc-block-colorpalette.mdx Docs: Update ColorPallete and example Jul 29, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@aberllin, thanks for putting together this pull request and helping us improve the documentation by adding this small but important example. We appreciate it 🙏 !

I left a small item for you to look into when you can.

Let me know once you've addressed it, and I'll take a look. If nothing more stands out, I'll gladly merge this pull request.

I hope you have a fantastic day.

Stay safe

Comment on lines 49 to 60
<ColorItem
title="gradient"
subtitle="Grayscale"
colors={{
Gradient: 'linear-gradient(to right,white,black)',
}}
/>
<ColorItem
title="gradient"
subtitle="Grayscale"
colors={['linear-gradient(65deg,white,black)']}
/>
Copy link
Contributor

Choose a reason for hiding this comment

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

@aberllin when you have a moment, can you adjust the spacing to match the rest of the example, as it's a bit off? It's using 4 spaces when it should be 2 spaces instead.

Copy link
Contributor Author

@aberllin aberllin Jul 29, 2024

Choose a reason for hiding this comment

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

Hi @jonniebigodes , please check again!
Thank you

@jonniebigodes
Copy link
Contributor

@aberllin thanks for addressing the feedback so promptly. Appreciate it 🙏 ! All is good on my end. Will merge once the checklist clears.

Copy link

nx-cloud bot commented Jul 29, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 65561ed. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Jul 29, 2024
@jonniebigodes jonniebigodes merged commit 61b8fc3 into storybookjs:next Jul 29, 2024
8 checks passed
storybook-bot pushed a commit that referenced this pull request Jul 29, 2024
Docs: Update ColorPallete and example
(cherry picked from commit 61b8fc3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
Docs: Update ColorPallete and example
(cherry picked from commit 61b8fc3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
Docs: Update ColorPallete and example
(cherry picked from commit 61b8fc3)
storybook-bot pushed a commit that referenced this pull request Jul 31, 2024
Docs: Update ColorPallete and example
(cherry picked from commit 61b8fc3)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants