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

115-ods component banners #438

Merged
merged 22 commits into from
Mar 1, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
1e04be0
[#115] Add component Banner to demo and lib
dolinetouko Feb 21, 2023
132fae7
[#115] Add documentation files
dolinetouko Feb 21, 2023
69d1609
[#115] Update documentation
dolinetouko Feb 21, 2023
1ba3ddf
[#115] Update banner component
dolinetouko Feb 22, 2023
a060141
[#115] Update component page
dolinetouko Feb 27, 2023
146a412
[#115] Update Banner image
dolinetouko Feb 27, 2023
8bcee07
[#115] Review : Change string name
dolinetouko Mar 1, 2023
1daddda
[#115] Review : change the position of the parameter in the Kdoc
dolinetouko Mar 1, 2023
d0443ca
[#115] Review : Change size
dolinetouko Mar 1, 2023
ed0382b
[#115] Review : Add preview
dolinetouko Mar 1, 2023
a5d10ac
[#115] Review : Change change log file
dolinetouko Mar 1, 2023
3decf9a
[#115] Review : Rename string
dolinetouko Mar 1, 2023
87a9654
[#115] Review : Change string file
dolinetouko Mar 1, 2023
59779d0
[#115] Review : Change parameter's position
dolinetouko Mar 1, 2023
a3c688c
[#115] Review : Delete space in code implementation
dolinetouko Mar 1, 2023
d83ecdf
[#115] Review : Change name in customization state
dolinetouko Mar 1, 2023
ff1fb9e
[#115] Review : Remove divider from customisation
dolinetouko Mar 1, 2023
b473d4d
[#115] Review : Update OdsBanner display
dolinetouko Mar 1, 2023
806d6f7
[#115] Review : add generic image
dolinetouko Mar 1, 2023
90f422a
[#115] Review : add implementation in the documentation
dolinetouko Mar 1, 2023
bb293cc
[#115] Improve doc
paulinea Mar 1, 2023
f98559c
[#115] Change OdsBanner signature: onButton1Click is mandatory now
paulinea Mar 1, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[#115] Add documentation files
  • Loading branch information
dolinetouko committed Mar 1, 2023
commit 132fae7444a7dc8dcff06d5d4e554ef69d40f6c7
5 changes: 2 additions & 3 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- \[Demo\] Add banner component ([#115](https://github.com/Orange-OpenSource/ods-android/issues/115))
- \[Lib\] Add label, current value and icon parameters to `OdsLinearProgressIndicator` component to display text and/or icon above the indicator, and the current value below if necessary ([#362](https://github.com/Orange-OpenSource/ods-android/issues/362))
- \[Lib\] Add label parameter to `OdsCircularProgressIndicator` component to display a text below the indicator ([#362](https://github.com/Orange-OpenSource/ods-android/issues/362))

### Changed

- \[Lib\] Rename `OdsTitleFirstCard` and `OdsImageFirstCard` respectively into `OdsVerticalHeaderFirstCard` and `OdsVerticalImageFirstCard` ([#432](https://github.com/Orange-OpenSource/ods-android/issues/432))
- \[Lib\] Add `OdsBanner` component ([#115](https://github.com/Orange-OpenSource/ods-android/issues/115))

### Fixed

Expand Down
2 changes: 2 additions & 0 deletions docs/_data/data_menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ toc2:
url: /components/AppBarsBottom_docs
- page: "App bars: top"
url: /components/AppBarsTop_docs
- page: Banners
url: /components/Banners_docs
- page: Buttons
url: /components/Buttons_docs
- page: Cards
Expand Down
42 changes: 42 additions & 0 deletions docs/components/Banners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
layout: detail
title: Banners
description: Banners displays an important message which requires an action to be dismissed.
---

A banner displays an important, succinct message, and provides actions for users to address (or dismiss the banner).
It requires a user action to be dismissed.

Banners should be displayed at the top of the screen, below a top app bar. They’re persistent and nonmodal, allowing the user to either ignore them or interact with them at any time.
Only one banner should be shown at a time

---

**Page Summary**

* [Specifications references](#specifications-references)
* [Accessibility](#accessibility)
* [Implementation](#implementation)
* [Component specific tokens](#component-specific-tokens)

---

## Specifications references

- [Design System Manager - Banners](https://system.design.orange.com/0c1af118d/p/19a040-banners/b/497b77)
- [Material Design - Snackbars](https://m2.material.io/components/banners)
- Technical documentation soon available

## Accessibility

Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/android/development/)

Users should be able to use the left phone buttons to interact with the banner.
The user should be able to hear the current state of the banner at all times.
Recommendation is available at the Orange Accessibility site

## Implementation

## Component specific tokens

_Soon available_
4 changes: 4 additions & 0 deletions docs/components/Banners_docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
layout: main
content_page: Banners.md
---