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

Cards : fix design + add design callout messages #2001

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

Conversation

isabellechanclou
Copy link
Member

@isabellechanclou isabellechanclou commented Apr 18, 2023

Related issues

Closes #1992
Linked to #1199

Description

After a design review of all the card variants, the purpose of this PR is to fix the design of some variants in order to make them aligned on the Orange design specifications and to add design callout messages before the variants that should not be used because not suitable in Orange design system.

Motivation & Context

The goal here is to offer in Boosted more guidance on what can be used or not in Orange apps and to reduce discrepancies between Boosted documentation and the Orange design system one.

Types of change

  • Bug fix (non-breaking which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (non-breaking change)
  • Breaking change (fix or feature that would change existing functionality)

Live previews

Checklist

Contribution

Accessibility

  • My change follows accessibility good practices; I have at least run axe

Design

  • My change respects the design guidelines defined in Orange Design System
  • My change is compatible with responsive display

Development

  • My change follows the developer guide
  • I have added JavaScript unit tests to cover my changes
  • I have added SCSS unit tests to cover my changes

Documentation

  • My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

  • My change introduces changes to the migration guide
  • My new component is added in Storybook
  • My new component is compatible with RTL
  • Manually run BrowserStack tests
  • Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
  • Code review
  • Design review
  • A11y review

After the merge

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@isabellechanclou isabellechanclou self-assigned this Apr 18, 2023
@isabellechanclou isabellechanclou added v5 component docs Improvements or additions to documentation fix labels Apr 18, 2023
@isabellechanclou isabellechanclou added this to In progress in 🟣 Sprint 20 - April/May 2023 via automation Apr 18, 2023
@netlify
Copy link

netlify bot commented Apr 18, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 9e033e9
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/659bd290a92e2f00089a5862
😎 Deploy Preview https://deploy-preview-2001--boosted.netlify.app/docs/5.3/components/card
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@isabellechanclou isabellechanclou linked an issue Apr 18, 2023 that may be closed by this pull request
44 tasks
@julien-deramond julien-deramond added this to In progress / Draft in 🟣 PR Board (Draft) via automation Apr 18, 2023
@julien-deramond julien-deramond moved this from In progress / Draft to Need Dev Review in 🟣 PR Board (Draft) Apr 18, 2023
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

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

Some few comments.

<br><br>
Regarding the available card sizes, please note that:

- **In the Orange Design System**, a card component is available in **3 sizes** that **can not be modified**. Depending on the size of your screen, you can adjust the cards layout by changing the cards size (choosing among the 3 existing sizes) and/or the number of cards to display on a single line.
Copy link
Member

Choose a reason for hiding this comment

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

Is that true ? Or do we need to wait for designer to be moreprecise on this ?

Copy link
Member Author

Choose a reason for hiding this comment

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

Dev + design told me to write this...

Copy link
Member

Choose a reason for hiding this comment

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

Well I don't know what to do with these informations but let's keep it for the lead dev review 🤷

Please refer to the [Cards](https://system.design.orange.com/0c1af118d/p/82eaf1-cards/b/69655e) guidelines on the Orange Design System website.
{{< /design-callout-alert >}}


Copy link
Member

Choose a reason for hiding this comment

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

Remove one blank line

@@ -12,6 +12,18 @@ toc: true

A **card** is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options. If you're familiar with Boosted 3, cards replace our old panels, wells, and thumbnails. Similar functionality to those components is available as modifier classes for cards.

{{< design-callout-alert info >}}
**On the Orange Design System website**, you'll find the [Cards](https://system.design.orange.com/0c1af118d/p/82eaf1-cards/b/69655e) component guidelines describing how Orange designers want cards to be represented and used.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
**On the Orange Design System website**, you'll find the [Cards](https://system.design.orange.com/0c1af118d/p/82eaf1-cards/b/69655e) component guidelines describing how Orange designers want cards to be represented and used.
**On the Orange Design System website**, you'll find the [Cards component guidelines](https://system.design.orange.com/0c1af118d/p/82eaf1-cards/b/69655e) describing how Orange designers want cards to be represented and used.

For better a11y

Copy link
Member Author

Choose a reason for hiding this comment

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

If I do that here, I will have to it in all the other design callout messages :-)
And then, what about "[Cards component design guidelines]" to be fully acurate?

- **In the Orange Design System**, a card component is available in **3 sizes** that **can not be modified**. Depending on the size of your screen, you can adjust the cards layout by changing the cards size (choosing among the 3 existing sizes) and/or the number of cards to display on a single line.

- **In Boosted**, as some card variants can be used as containers, more sizing possibilities are offered to adjust their sizes.
{{< /design-callout-alert >}}
Copy link
Member

Choose a reason for hiding this comment

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

The layout seems a bit weird to me atm.

Copy link
Member Author

Choose a reason for hiding this comment

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

I kind of agree, but it's not obviously better without the free lines between paragraphs. I'll try to find another way to display that info.

site/content/docs/5.3/components/card.md Show resolved Hide resolved
site/content/docs/5.3/components/card.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/card.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/card.md Outdated Show resolved Hide resolved
site/content/docs/5.3/components/card.md Outdated Show resolved Hide resolved
@@ -423,6 +460,12 @@ Cards include various options for customizing their backgrounds, borders, and co

Set a `background-color` with contrasting foreground `color` with [our `.text-bg-{color}` helpers]({{< docsref "helpers/color-background" >}}). Previously it was required to manually pair your choice of [`.text-{color}`]({{< docsref "/utilities/colors" >}}) and [`.bg-{color}`]({{< docsref "/utilities/background" >}}) utilities for styling, which you still may use if you prefer.

{{< design-callout-alert >}}
These variants **with a colored background** should not be used because they do not respect the Orange Design System specifications.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
These variants **with a colored background** should not be used because they do not respect the Orange Design System specifications.
These variants **with a colored background** should not be used because they do not respect the Orange Design System specifications. The background should either be black or white.

Values might need an update

Copy link
Member

Choose a reason for hiding this comment

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

I propose:
The variants with a colored background (except black background) should not be used because they do not respect the Orange Design System specifications.

@sonarcloud
Copy link

sonarcloud bot commented May 12, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component docs Improvements or additions to documentation fix v5
Projects
Status: Dev Review In Progress
🟣 PR Board (Draft)
Need Dev Review
Development

Successfully merging this pull request may close these issues.

Cards : fix design + add design callout messages
3 participants