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 > Content > Tables: Add design callout messages #2032

Merged
merged 3 commits into from
Jul 28, 2023

Conversation

isabellechanclou
Copy link
Member

@isabellechanclou isabellechanclou commented May 12, 2023

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

#1614

Description

After a design review of all the table variants, it came out that 2 design callout messages needed to be added before variants (accented tables and nesting) that should not be used according to the Orange design system.

Motivation & Context

Change required to prevent Boosted user from using in their app component variants that are not suitable in the Orange Design System.

Types of change

  • New feature (non-breaking change which adds 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

@isabellechanclou isabellechanclou added bug v5 component docs Improvements or additions to documentation labels May 12, 2023
@isabellechanclou isabellechanclou self-assigned this May 12, 2023
@netlify
Copy link

netlify bot commented May 12, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit cf7f5e1
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/64c37f3626c576000900629c
😎 Deploy Preview https://deploy-preview-2032--boosted.netlify.app
📱 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.

@@ -80,6 +80,10 @@ Use contextual class to color tables, table rows or individual cells.

## Accented tables

{{< design-callout-alert info >}}
It is possible to use striped rows **or** striped columns in your tables, but you **can't use both in a same table**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we explain why? 'because it does not respect the Orange Design System specifications' for instance?

Copy link
Member

Choose a reason for hiding this comment

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

We are not showing examples where we use both in the same table. Is this callout really needed?

Copy link
Member Author

Choose a reason for hiding this comment

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

Should we explain why? 'because it does not respect the Orange Design System specifications' for instance?

Good point Mewen. Indeed, it would be better to write: "It is possible to use striped rows or striped columns in your tables, but you can't use both in a same table because it does not respect the Orange Design System specifications."

Copy link
Member Author

Choose a reason for hiding this comment

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

We are not showing examples where we use both in the same table. Is this callout really needed?

We thought this design callout message would be necessary to avoid users using both horizontal and vertical striped at the same time, knowing that in the following section "Striped columns", there is an example that could be misleading: it shows 2 striped columns + a striped line (but not the entire line).

Copy link
Member

@hannahiss hannahiss Jul 4, 2023

Choose a reason for hiding this comment

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

there is an example that could be misleading: it shows 2 striped columns + a striped line (but not the entire line).

Yes, this example is really confusing, it is just striped columns, but in the third line, 2 cells are merged with a colspan="2". (example from Bootstrap)

Copy link
Member

Choose a reason for hiding this comment

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

IMHO it's obvious that one shouldn't use both at the same time. I vote for not adding this callout. Moreover, the doc doesn't show that they can be used at the same time, it only shows the rendering when there are merged cells.

Copy link
Member Author

Choose a reason for hiding this comment

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

It this it only shows the rendering when there are merged cells. that can be confusing to me and motivated my adding the design callout.

Copy link
Contributor

@MewenLeHo MewenLeHo left a comment

Choose a reason for hiding this comment

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

Just two questions to tackle.

@sonarcloud
Copy link

sonarcloud bot commented May 22, 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

Copy link
Member

@julien-deramond julien-deramond left a comment

Choose a reason for hiding this comment

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

Still not a big fan of this callout, but the majority prevails. Let's ship it.

@julien-deramond julien-deramond merged commit f907f4c into main Jul 28, 2023
12 checks passed
@julien-deramond julien-deramond deleted the main-ic-add-design-callouts-in-tables branch July 28, 2023 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug component docs Improvements or additions to documentation v5
Projects
Development

Successfully merging this pull request may close these issues.

4 participants