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

Title bars #956

Merged
merged 26 commits into from
May 4, 2022
Merged

Title bars #956

merged 26 commits into from
May 4, 2022

Conversation

louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Nov 30, 2021

Previews :
https://deploy-preview-956--boosted.netlify.app/docs/5.1/examples/title-bars/
https://deploy-preview-956--boosted.netlify.app/docs/5.1/components/title-bars/

DoD

Development

  • Should match specs (eg. either the Web UI Kit or any pattern from the WAI — or both…)
  • Docs added:
    • including the "Sass" part using scss-docs shortcode
    • in /about/overview/#custom-components if it is a new Orange custom component
    • in /getting-started/introduction/#components if it is a new Orange custom component that requires JavaScript (and Popper)
    • in /customize/overview#csps-and-embedded-svgs if it is a new Orange custom component that includes embedded SVGs in our CSS
    • in /forms/validation/?#supported-elements if it is a new Orange custom component that is a form control
    • in /forms/overview/ if it is a new Orange custom component that is a form control
  • Check (and fix) RTL version
  • Run linters
  • Run compilers
  • Tests added for JS-side
  • Run tests
  • Manually run BrowserStack test
  • Manually run Percy test
  • Cross-browser test:
    • Firefox ESR
    • Latest Edge, Chrome, Firefox, Safari
    • iOS Safari
    • Chrome & Firefox on Android
  • Clean up the branch using rebase -i
  • Commited with feat(…): … message
  • Mention it in Migration Guide (if back-from-v4): renamed variables, changes in markup requirement, etc.

Reviews

  • Code review
  • A11y review
  • Design review

@louismaximepiton louismaximepiton linked an issue Nov 30, 2021 that may be closed by this pull request
@julien-deramond

This comment has been minimized.

@louismaximepiton louismaximepiton mentioned this pull request Dec 3, 2021
20 tasks
@julien-deramond
Copy link
Member

Note: If #982 is closed before the review of this PR, we must apply here the Title Bars to the documentation templates. Otherwise, we need to modify the description of the issue to notify the developer to use Title Bars.

@louismaximepiton

This comment has been minimized.

@louismaximepiton louismaximepiton marked this pull request as ready for review December 22, 2021 16:30
@julien-deramond julien-deramond changed the title feat: Title bars Title bars Dec 30, 2021
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.

First series of comments without digging at the examples and .scss.

<div class="container">
<h1>Svg image</h1>
<svg aria-hidden="true" focusable="false">
<use xlink:href="/docs/{{< param docs_version >}}/assets/img/boosted-sprite.svg#logo"/>
Copy link
Member

Choose a reason for hiding this comment

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

  • It is not a good practice to have the logo here. Replace it with a simple inline SVG and remove it from site/static/docs/5.1/assets/img/boosted-sprite.svg.
  • It is said further that the title should not wrap: it is the case here.
    Moreover, the SVG shouldn't be right-aligned?

Copy link
Member Author

Choose a reason for hiding this comment

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

In this case, it wraps because of the width of the main container, do you think that I should add : word-break: keep-all ?

site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
site/content/docs/5.1/components/orange-local-headers.md Outdated Show resolved Hide resolved
scss/_title-bars.scss Show resolved Hide resolved
scss/_title-bars.scss Outdated Show resolved Hide resolved
@julien-deramond
Copy link
Member

@louismaximepiton #1009 is merged so we should try to include Title bars into "Examples" and "Guidelines" pages for the titles.

@Franco-Riccitelli
Copy link

I have completed a design review of the title bars and there are no issues - great work!
Please note, title bars can be displayed with black or white backgrounds. When using black or white backgrounds, illustrations can be included as an option, but it's not necessary.
Supporting colours can also be used as the background colour for title bars, but not the supporting light and dark tint colours. When using one of the supporting colours, Illustrations must be used.
The illustration used in the implementation is a good example of how to use illustrations in title bars, especially across the breakpoints, but it must be possible to replace this with other illustrations if needed. Thanks

@isabellechanclou
Copy link
Member

Thanks @Franco-Riccitelli for your review and comments. Considering the rules you mentioned, we added them to complete the documentation part accordingly. By the way, it would be useful to have theses rules also mentioned in ODS.

louismaximepiton and others added 15 commits May 3, 2022 07:42
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
…xample page

Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
Signed-off-by: louismaximepiton <louismaxime.piton@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
@julien-deramond
Copy link
Member

Added a CSS section in the documentation via d02f9f0


border-bottom: var(--#{$boosted-prefix}title-bar-border-width) solid var(--#{$boosted-prefix}title-bar-border-color);

@include media-breakpoint-up(md) {
Copy link
Member

Choose a reason for hiding this comment

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

Apparently in the DSM we have to following sizes for the header: 60px 50px 30px. It looks like .display-1. Can't we use this class instead?

Copy link
Member

Choose a reason for hiding this comment

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

OK I understand, the breakpoints are different between the DSM for this component and our breakpoints in Boosted regarding headers... Let's add .display-1 in this PR and fix the behavior in the CSS, and then create an issue to align the DSM and Boosted for the headers.

Copy link
Member Author

Choose a reason for hiding this comment

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

Just a reminder for the one that will create the issue, the actual breakpoints for display-* are sm and lg. Here, we need md and xl.

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.

  • Some space's missing between the border and the description in mobile mode.

Screenshot from 2022-05-03 08-25-54

  • The example thumbnail should be update to show the content of the examples rather than an image contained in the title bars.

site/content/docs/5.1/components/title-bars.md Outdated Show resolved Hide resolved
site/data/examples.yml Show resolved Hide resolved
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.

Final review with 2 small comments. After the fixes, let's merge 🚀

site/content/docs/5.1/examples/title-bars/index.html Outdated Show resolved Hide resolved
site/content/docs/5.1/components/title-bars.md Outdated Show resolved Hide resolved
@julien-deramond julien-deramond merged commit a5f48ab into main May 4, 2022
@julien-deramond julien-deramond deleted the main-lmp-title-bar branch May 4, 2022 05:47
This was referenced May 4, 2022
hannahiss pushed a commit that referenced this pull request May 19, 2022
Signed-off-by: Louis-Maxime Piton <louismaxime.piton@orange.com>
Signed-off-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Signed-off-by: Julien Déramond <isabelle.chanclou@orange.com>

Co-authored-by: Louis-Maxime Piton <louismaxime.piton@orange.com>
Co-authored-by: Isabelle Chanclou <isabelle.chanclou@orange.com>
Co-authored-by: Julien Déramond <julien.deramond@orange.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Local Headers > Title Bar
4 participants