Skip to content

Commit

Permalink
[#115] Add documentation files
Browse files Browse the repository at this point in the history
  • Loading branch information
dolinetouko committed Mar 1, 2023
1 parent 1e04be0 commit 132fae7
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 3 deletions.
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
---

0 comments on commit 132fae7

Please sign in to comment.