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

Add refactored Callout component, replace Call-out [fix #787] #908

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

craigcook
Copy link
Contributor

@craigcook craigcook commented Dec 7, 2023

Description

This refactors the Callout, but also changes the name so it effectively removes and replaces the previous component.

The revised Callout:

  1. Removes integrated branding options. We can use Logo/Wordmark components for branding.
  2. Treats Compact Callout as a layout variant rather than as a separate component.

This also means a Callout can replace a default centered Hero, and we can finally fully remove the Hero component.

However, since this renames/replaces a component it's a breaking change and will need a major release. We could keep the old name but I prefer it without a dash. But moreover I wanted to make the compact version a variant and not a whole component, so that would deprecate Compact Call-out anyway.

So... if we really care about gradual deprecation and keeping old components for a while to let people transition, we shouldn't change the name. But I want to change the name, and keeping the dashed and undashed names is even messier than just doing it.

  • I have documented this change in the design system.
  • I have recorded this change in CHANGELOG.md.

Issue

#787

Testing

https://demo2--mozilla-protocol.netlify.app/components/detail/callout--default
http://localhost:3000/components/detail/callout--default

@craigcook craigcook added the Needs:Review 👋 Ready for Developer Review label Dec 7, 2023
@craigcook craigcook removed their assignment Dec 15, 2023
@nathan-barrett nathan-barrett self-assigned this Dec 21, 2023
Copy link
Contributor

@nathan-barrett nathan-barrett left a comment

Choose a reason for hiding this comment

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

rwc+ Thats a great looking callout. Just some minor documentation questions

CHANGELOG.md Outdated Show resolved Hide resolved
components/hero/readme.md Outdated Show resolved Hide resolved
@craigcook craigcook merged commit 8f89eaf into mozilla:main Jan 8, 2024
2 checks passed
@craigcook craigcook deleted the 787-callout branch January 8, 2024 16:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs:Review 👋 Ready for Developer Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants