From eb2f4dc317367a991955bdfb2e8b5d7cfc3b600f Mon Sep 17 00:00:00 2001 From: Pauline Auvray Date: Tue, 7 Feb 2023 14:40:46 +0100 Subject: [PATCH] [#424] Prepare release 0.10.0 --- DEVELOP.md | 2 +- changelog.md | 2 +- docs/0.10.0/404.html | 26 ++ docs/0.10.0/components/AppBarsBottom.md | 167 ++++++++++ docs/0.10.0/components/AppBarsBottom_docs.md | 4 + docs/0.10.0/components/AppBarsTop.md | 269 ++++++++++++++++ docs/0.10.0/components/AppBarsTop_docs.md | 4 + docs/0.10.0/components/Buttons.md | 297 ++++++++++++++++++ docs/0.10.0/components/Buttons_docs.md | 4 + docs/0.10.0/components/Cards.md | 231 ++++++++++++++ docs/0.10.0/components/Cards_docs.md | 4 + docs/0.10.0/components/Checkboxes.md | 72 +++++ docs/0.10.0/components/Checkboxes_docs.md | 4 + docs/0.10.0/components/Chips.md | 258 +++++++++++++++ docs/0.10.0/components/Chips_docs.md | 4 + docs/0.10.0/components/Dialogs.md | 129 ++++++++ docs/0.10.0/components/Dialogs_docs.md | 4 + .../components/FloatingActionButtons.md | 264 ++++++++++++++++ .../components/FloatingActionButtons_docs.md | 4 + docs/0.10.0/components/Lists.md | 158 ++++++++++ docs/0.10.0/components/Lists_docs.md | 4 + docs/0.10.0/components/Menus.md | 107 +++++++ docs/0.10.0/components/Menus_docs.md | 4 + docs/0.10.0/components/NavigationBottom.md | 148 +++++++++ .../components/NavigationBottom_docs.md | 4 + docs/0.10.0/components/ProgressIndicators.md | 165 ++++++++++ .../components/ProgressIndicators_docs.md | 4 + docs/0.10.0/components/RadioButtons.md | 115 +++++++ docs/0.10.0/components/RadioButtons_docs.md | 4 + docs/0.10.0/components/Sliders.md | 246 +++++++++++++++ docs/0.10.0/components/Sliders_docs.md | 4 + docs/0.10.0/components/Snackbars.md | 140 +++++++++ docs/0.10.0/components/Snackbars_docs.md | 4 + docs/0.10.0/components/Switches.md | 108 +++++++ docs/0.10.0/components/Switches_docs.md | 4 + docs/0.10.0/components/Tabs.md | 250 +++++++++++++++ docs/0.10.0/components/Tabs_docs.md | 4 + docs/0.10.0/components/TextFields.md | 260 +++++++++++++++ docs/0.10.0/components/TextFields_docs.md | 4 + .../images/app_bar_top_overflow_menu_dark.png | Bin 0 -> 22014 bytes .../app_bar_top_overflow_menu_light.png | Bin 0 -> 21398 bytes .../images/bottom_navigation_dark.png | Bin 0 -> 16394 bytes .../images/bottom_navigation_light.png | Bin 0 -> 14003 bytes .../images/button_contained_dark.png | Bin 0 -> 5081 bytes .../images/button_contained_light.png | Bin 0 -> 5106 bytes .../images/button_contained_negative_dark.png | Bin 0 -> 3968 bytes .../button_contained_negative_light.png | Bin 0 -> 3929 bytes .../images/button_contained_positive_dark.png | Bin 0 -> 3730 bytes .../button_contained_positive_light.png | Bin 0 -> 3674 bytes .../components/images/button_icon_dark.png | Bin 0 -> 3450 bytes .../components/images/button_icon_light.png | Bin 0 -> 2971 bytes .../images/button_outlined_dark.png | Bin 0 -> 4952 bytes .../images/button_outlined_light.png | Bin 0 -> 5229 bytes .../components/images/button_text_dark.png | Bin 0 -> 5006 bytes .../components/images/button_text_light.png | Bin 0 -> 4808 bytes .../components/images/button_toggle_dark.png | Bin 0 -> 6687 bytes .../components/images/button_toggle_light.png | Bin 0 -> 6480 bytes .../images/card_image_first_dark.png | Bin 0 -> 39238 bytes .../images/card_image_first_light.png | Bin 0 -> 38487 bytes .../components/images/card_small_dark.png | Bin 0 -> 6326 bytes .../components/images/card_small_light.png | Bin 0 -> 6705 bytes .../images/card_title_first_dark.png | Bin 0 -> 30929 bytes .../images/card_title_first_light.png | Bin 0 -> 28496 bytes .../components/images/checkbox_dark.png | Bin 0 -> 15600 bytes .../components/images/checkbox_light.png | Bin 0 -> 13750 bytes .../components/images/chips_action_dark.png | Bin 0 -> 5102 bytes .../components/images/chips_action_light.png | Bin 0 -> 4929 bytes .../images/chips_action_outlined_dark.png | Bin 0 -> 5287 bytes .../images/chips_action_outlined_light.png | Bin 0 -> 4740 bytes .../components/images/chips_choice_dark.png | Bin 0 -> 16176 bytes .../images/chips_choice_flow_row_dark.png | Bin 0 -> 19250 bytes .../images/chips_choice_flow_row_light.png | Bin 0 -> 19577 bytes .../components/images/chips_choice_light.png | Bin 0 -> 16467 bytes .../images/chips_choice_outlined_dark.png | Bin 0 -> 17666 bytes .../images/chips_choice_outlined_light.png | Bin 0 -> 15946 bytes .../images/chips_filter_avatar_dark.png | Bin 0 -> 15171 bytes .../images/chips_filter_avatar_light.png | Bin 0 -> 14475 bytes .../components/images/chips_filter_dark.png | Bin 0 -> 14622 bytes .../components/images/chips_filter_light.png | Bin 0 -> 14545 bytes .../components/images/chips_input_dark.png | Bin 0 -> 6956 bytes .../components/images/chips_input_light.png | Bin 0 -> 6642 bytes .../images/chips_input_outlined_dark.png | Bin 0 -> 7706 bytes .../images/chips_input_outlined_light.png | Bin 0 -> 7419 bytes .../components/images/dialog_alert_dark.png | Bin 0 -> 34137 bytes .../components/images/dialog_alert_light.png | Bin 0 -> 31752 bytes docs/0.10.0/components/images/fab_dark.png | Bin 0 -> 8437 bytes .../components/images/fab_extended_dark.png | Bin 0 -> 12886 bytes .../images/fab_extended_full_width_dark.png | Bin 0 -> 13612 bytes .../images/fab_extended_full_width_light.png | Bin 0 -> 15883 bytes .../components/images/fab_extended_light.png | Bin 0 -> 13169 bytes docs/0.10.0/components/images/fab_light.png | Bin 0 -> 8566 bytes .../components/images/fab_mini_dark.png | Bin 0 -> 5022 bytes .../components/images/fab_mini_light.png | Bin 0 -> 5158 bytes .../images/lists_single_line_dark.png | Bin 0 -> 6745 bytes .../images/lists_single_line_light.png | Bin 0 -> 7027 bytes .../lists_single_line_wide_image_dark.png | Bin 0 -> 6944 bytes .../lists_single_line_wide_image_light.png | Bin 0 -> 7012 bytes .../images/lists_three_line_dark.png | Bin 0 -> 20388 bytes .../images/lists_three_line_light.png | Bin 0 -> 19072 bytes .../lists_three_line_wide_image_dark.png | Bin 0 -> 17242 bytes .../lists_three_line_wide_image_light.png | Bin 0 -> 17469 bytes .../components/images/lists_two_line_dark.png | Bin 0 -> 12134 bytes .../images/lists_two_line_light.png | Bin 0 -> 11639 bytes .../images/lists_two_line_wide_image_dark.png | Bin 0 -> 10130 bytes .../lists_two_line_wide_image_light.png | Bin 0 -> 9957 bytes .../components/images/menu_dropdown_dark.png | Bin 0 -> 34932 bytes .../components/images/menu_dropdown_light.png | Bin 0 -> 33348 bytes .../images/menu_exposed_dropdown_dark.png | Bin 0 -> 32525 bytes .../images/menu_exposed_dropdown_light.png | Bin 0 -> 32532 bytes .../images/progress_activity_dark.png | Bin 0 -> 5175 bytes .../images/progress_activity_light.png | Bin 0 -> 5711 bytes .../components/images/progress_bar_dark.png | Bin 0 -> 2126 bytes .../components/images/progress_bar_light.png | Bin 0 -> 2240 bytes .../components/images/radio_button_dark.png | Bin 0 -> 17480 bytes .../components/images/radio_button_light.png | Bin 0 -> 15709 bytes .../images/slider_continuous_dark.png | Bin 0 -> 9755 bytes .../images/slider_continuous_light.png | Bin 0 -> 9311 bytes .../images/slider_continuous_lockups_dark.png | Bin 0 -> 6565 bytes .../slider_continuous_lockups_light.png | Bin 0 -> 6809 bytes ...ider_continuous_lockups_with_icon_dark.png | Bin 0 -> 12984 bytes ...der_continuous_lockups_with_icon_light.png | Bin 0 -> 13343 bytes .../slider_continuous_with_icon_dark.png | Bin 0 -> 8721 bytes .../slider_continuous_with_icon_light.png | Bin 0 -> 9027 bytes .../images/slider_discrete_dark.png | Bin 0 -> 10767 bytes .../images/slider_discrete_light.png | Bin 0 -> 10489 bytes .../images/slider_discrete_lockups_dark.png | Bin 0 -> 7978 bytes .../images/slider_discrete_lockups_light.png | Bin 0 -> 7948 bytes ...slider_discrete_lockups_with_icon_dark.png | Bin 0 -> 16689 bytes ...lider_discrete_lockups_with_icon_light.png | Bin 0 -> 15873 bytes .../images/slider_discrete_with_icon_dark.png | Bin 0 -> 9648 bytes .../slider_discrete_with_icon_light.png | Bin 0 -> 9605 bytes .../components/images/snackbar_dark.png | Bin 0 -> 14879 bytes .../components/images/snackbar_light.png | Bin 0 -> 15914 bytes .../images/snackbar_with_action_dark.png | Bin 0 -> 22064 bytes .../images/snackbar_with_action_light.png | Bin 0 -> 22807 bytes docs/0.10.0/components/images/switch_dark.png | Bin 0 -> 16286 bytes .../0.10.0/components/images/switch_light.png | Bin 0 -> 14865 bytes .../components/images/tabs_fixed_dark.png | Bin 0 -> 12901 bytes .../components/images/tabs_fixed_light.png | Bin 0 -> 11515 bytes .../images/tabs_scrollable_dark.png | Bin 0 -> 13922 bytes .../images/tabs_scrollable_light.png | Bin 0 -> 12283 bytes .../textfield_character_counter_dark.png | Bin 0 -> 7270 bytes .../textfield_character_counter_light.png | Bin 0 -> 7356 bytes .../images/textfield_filled_dark.png | Bin 0 -> 7923 bytes .../images/textfield_filled_light.png | Bin 0 -> 8075 bytes .../images/textfield_filled_password_dark.png | Bin 0 -> 6028 bytes .../textfield_filled_password_light.png | Bin 0 -> 6057 bytes .../images/textfield_outlined_dark.png | Bin 0 -> 7891 bytes .../images/textfield_outlined_light.png | Bin 0 -> 7852 bytes .../textfield_outlined_password_dark.png | Bin 0 -> 5854 bytes .../textfield_outlined_password_light.png | Bin 0 -> 6055 bytes docs/0.10.0/guidelines/Colors.md | 55 ++++ docs/0.10.0/guidelines/Colors_docs.md | 4 + docs/0.10.0/guidelines/Typography.md | 49 +++ docs/0.10.0/guidelines/Typography_docs.md | 4 + docs/0.10.0/home_content.md | 105 +++++++ docs/0.10.0/index.md | 6 + docs/0.10.0/index_content.md | 6 + docs/_config.yml | 4 + docs/_config_netlify.yml | 4 + docs/home_content.md | 2 +- gradle.properties | 2 +- 162 files changed, 3723 insertions(+), 4 deletions(-) create mode 100644 docs/0.10.0/404.html create mode 100644 docs/0.10.0/components/AppBarsBottom.md create mode 100644 docs/0.10.0/components/AppBarsBottom_docs.md create mode 100644 docs/0.10.0/components/AppBarsTop.md create mode 100644 docs/0.10.0/components/AppBarsTop_docs.md create mode 100644 docs/0.10.0/components/Buttons.md create mode 100644 docs/0.10.0/components/Buttons_docs.md create mode 100644 docs/0.10.0/components/Cards.md create mode 100644 docs/0.10.0/components/Cards_docs.md create mode 100644 docs/0.10.0/components/Checkboxes.md create mode 100644 docs/0.10.0/components/Checkboxes_docs.md create mode 100644 docs/0.10.0/components/Chips.md create mode 100644 docs/0.10.0/components/Chips_docs.md create mode 100644 docs/0.10.0/components/Dialogs.md create mode 100644 docs/0.10.0/components/Dialogs_docs.md create mode 100644 docs/0.10.0/components/FloatingActionButtons.md create mode 100644 docs/0.10.0/components/FloatingActionButtons_docs.md create mode 100644 docs/0.10.0/components/Lists.md create mode 100644 docs/0.10.0/components/Lists_docs.md create mode 100644 docs/0.10.0/components/Menus.md create mode 100644 docs/0.10.0/components/Menus_docs.md create mode 100644 docs/0.10.0/components/NavigationBottom.md create mode 100644 docs/0.10.0/components/NavigationBottom_docs.md create mode 100644 docs/0.10.0/components/ProgressIndicators.md create mode 100644 docs/0.10.0/components/ProgressIndicators_docs.md create mode 100644 docs/0.10.0/components/RadioButtons.md create mode 100644 docs/0.10.0/components/RadioButtons_docs.md create mode 100644 docs/0.10.0/components/Sliders.md create mode 100644 docs/0.10.0/components/Sliders_docs.md create mode 100644 docs/0.10.0/components/Snackbars.md create mode 100644 docs/0.10.0/components/Snackbars_docs.md create mode 100644 docs/0.10.0/components/Switches.md create mode 100644 docs/0.10.0/components/Switches_docs.md create mode 100644 docs/0.10.0/components/Tabs.md create mode 100644 docs/0.10.0/components/Tabs_docs.md create mode 100644 docs/0.10.0/components/TextFields.md create mode 100644 docs/0.10.0/components/TextFields_docs.md create mode 100644 docs/0.10.0/components/images/app_bar_top_overflow_menu_dark.png create mode 100644 docs/0.10.0/components/images/app_bar_top_overflow_menu_light.png create mode 100644 docs/0.10.0/components/images/bottom_navigation_dark.png create mode 100644 docs/0.10.0/components/images/bottom_navigation_light.png create mode 100644 docs/0.10.0/components/images/button_contained_dark.png create mode 100644 docs/0.10.0/components/images/button_contained_light.png create mode 100644 docs/0.10.0/components/images/button_contained_negative_dark.png create mode 100644 docs/0.10.0/components/images/button_contained_negative_light.png create mode 100644 docs/0.10.0/components/images/button_contained_positive_dark.png create mode 100644 docs/0.10.0/components/images/button_contained_positive_light.png create mode 100644 docs/0.10.0/components/images/button_icon_dark.png create mode 100644 docs/0.10.0/components/images/button_icon_light.png create mode 100644 docs/0.10.0/components/images/button_outlined_dark.png create mode 100644 docs/0.10.0/components/images/button_outlined_light.png create mode 100644 docs/0.10.0/components/images/button_text_dark.png create mode 100644 docs/0.10.0/components/images/button_text_light.png create mode 100644 docs/0.10.0/components/images/button_toggle_dark.png create mode 100644 docs/0.10.0/components/images/button_toggle_light.png create mode 100644 docs/0.10.0/components/images/card_image_first_dark.png create mode 100644 docs/0.10.0/components/images/card_image_first_light.png create mode 100644 docs/0.10.0/components/images/card_small_dark.png create mode 100644 docs/0.10.0/components/images/card_small_light.png create mode 100644 docs/0.10.0/components/images/card_title_first_dark.png create mode 100644 docs/0.10.0/components/images/card_title_first_light.png create mode 100644 docs/0.10.0/components/images/checkbox_dark.png create mode 100644 docs/0.10.0/components/images/checkbox_light.png create mode 100644 docs/0.10.0/components/images/chips_action_dark.png create mode 100644 docs/0.10.0/components/images/chips_action_light.png create mode 100644 docs/0.10.0/components/images/chips_action_outlined_dark.png create mode 100644 docs/0.10.0/components/images/chips_action_outlined_light.png create mode 100644 docs/0.10.0/components/images/chips_choice_dark.png create mode 100644 docs/0.10.0/components/images/chips_choice_flow_row_dark.png create mode 100644 docs/0.10.0/components/images/chips_choice_flow_row_light.png create mode 100644 docs/0.10.0/components/images/chips_choice_light.png create mode 100644 docs/0.10.0/components/images/chips_choice_outlined_dark.png create mode 100644 docs/0.10.0/components/images/chips_choice_outlined_light.png create mode 100644 docs/0.10.0/components/images/chips_filter_avatar_dark.png create mode 100644 docs/0.10.0/components/images/chips_filter_avatar_light.png create mode 100644 docs/0.10.0/components/images/chips_filter_dark.png create mode 100644 docs/0.10.0/components/images/chips_filter_light.png create mode 100644 docs/0.10.0/components/images/chips_input_dark.png create mode 100644 docs/0.10.0/components/images/chips_input_light.png create mode 100644 docs/0.10.0/components/images/chips_input_outlined_dark.png create mode 100644 docs/0.10.0/components/images/chips_input_outlined_light.png create mode 100644 docs/0.10.0/components/images/dialog_alert_dark.png create mode 100644 docs/0.10.0/components/images/dialog_alert_light.png create mode 100644 docs/0.10.0/components/images/fab_dark.png create mode 100644 docs/0.10.0/components/images/fab_extended_dark.png create mode 100644 docs/0.10.0/components/images/fab_extended_full_width_dark.png create mode 100644 docs/0.10.0/components/images/fab_extended_full_width_light.png create mode 100644 docs/0.10.0/components/images/fab_extended_light.png create mode 100644 docs/0.10.0/components/images/fab_light.png create mode 100644 docs/0.10.0/components/images/fab_mini_dark.png create mode 100644 docs/0.10.0/components/images/fab_mini_light.png create mode 100644 docs/0.10.0/components/images/lists_single_line_dark.png create mode 100644 docs/0.10.0/components/images/lists_single_line_light.png create mode 100644 docs/0.10.0/components/images/lists_single_line_wide_image_dark.png create mode 100644 docs/0.10.0/components/images/lists_single_line_wide_image_light.png create mode 100644 docs/0.10.0/components/images/lists_three_line_dark.png create mode 100644 docs/0.10.0/components/images/lists_three_line_light.png create mode 100644 docs/0.10.0/components/images/lists_three_line_wide_image_dark.png create mode 100644 docs/0.10.0/components/images/lists_three_line_wide_image_light.png create mode 100644 docs/0.10.0/components/images/lists_two_line_dark.png create mode 100644 docs/0.10.0/components/images/lists_two_line_light.png create mode 100644 docs/0.10.0/components/images/lists_two_line_wide_image_dark.png create mode 100644 docs/0.10.0/components/images/lists_two_line_wide_image_light.png create mode 100644 docs/0.10.0/components/images/menu_dropdown_dark.png create mode 100644 docs/0.10.0/components/images/menu_dropdown_light.png create mode 100644 docs/0.10.0/components/images/menu_exposed_dropdown_dark.png create mode 100644 docs/0.10.0/components/images/menu_exposed_dropdown_light.png create mode 100644 docs/0.10.0/components/images/progress_activity_dark.png create mode 100644 docs/0.10.0/components/images/progress_activity_light.png create mode 100644 docs/0.10.0/components/images/progress_bar_dark.png create mode 100644 docs/0.10.0/components/images/progress_bar_light.png create mode 100644 docs/0.10.0/components/images/radio_button_dark.png create mode 100644 docs/0.10.0/components/images/radio_button_light.png create mode 100644 docs/0.10.0/components/images/slider_continuous_dark.png create mode 100644 docs/0.10.0/components/images/slider_continuous_light.png create mode 100644 docs/0.10.0/components/images/slider_continuous_lockups_dark.png create mode 100644 docs/0.10.0/components/images/slider_continuous_lockups_light.png create mode 100644 docs/0.10.0/components/images/slider_continuous_lockups_with_icon_dark.png create mode 100644 docs/0.10.0/components/images/slider_continuous_lockups_with_icon_light.png create mode 100644 docs/0.10.0/components/images/slider_continuous_with_icon_dark.png create mode 100644 docs/0.10.0/components/images/slider_continuous_with_icon_light.png create mode 100644 docs/0.10.0/components/images/slider_discrete_dark.png create mode 100644 docs/0.10.0/components/images/slider_discrete_light.png create mode 100644 docs/0.10.0/components/images/slider_discrete_lockups_dark.png create mode 100644 docs/0.10.0/components/images/slider_discrete_lockups_light.png create mode 100644 docs/0.10.0/components/images/slider_discrete_lockups_with_icon_dark.png create mode 100644 docs/0.10.0/components/images/slider_discrete_lockups_with_icon_light.png create mode 100644 docs/0.10.0/components/images/slider_discrete_with_icon_dark.png create mode 100644 docs/0.10.0/components/images/slider_discrete_with_icon_light.png create mode 100644 docs/0.10.0/components/images/snackbar_dark.png create mode 100644 docs/0.10.0/components/images/snackbar_light.png create mode 100644 docs/0.10.0/components/images/snackbar_with_action_dark.png create mode 100644 docs/0.10.0/components/images/snackbar_with_action_light.png create mode 100644 docs/0.10.0/components/images/switch_dark.png create mode 100644 docs/0.10.0/components/images/switch_light.png create mode 100644 docs/0.10.0/components/images/tabs_fixed_dark.png create mode 100644 docs/0.10.0/components/images/tabs_fixed_light.png create mode 100644 docs/0.10.0/components/images/tabs_scrollable_dark.png create mode 100644 docs/0.10.0/components/images/tabs_scrollable_light.png create mode 100644 docs/0.10.0/components/images/textfield_character_counter_dark.png create mode 100644 docs/0.10.0/components/images/textfield_character_counter_light.png create mode 100644 docs/0.10.0/components/images/textfield_filled_dark.png create mode 100644 docs/0.10.0/components/images/textfield_filled_light.png create mode 100644 docs/0.10.0/components/images/textfield_filled_password_dark.png create mode 100644 docs/0.10.0/components/images/textfield_filled_password_light.png create mode 100644 docs/0.10.0/components/images/textfield_outlined_dark.png create mode 100644 docs/0.10.0/components/images/textfield_outlined_light.png create mode 100644 docs/0.10.0/components/images/textfield_outlined_password_dark.png create mode 100644 docs/0.10.0/components/images/textfield_outlined_password_light.png create mode 100644 docs/0.10.0/guidelines/Colors.md create mode 100644 docs/0.10.0/guidelines/Colors_docs.md create mode 100644 docs/0.10.0/guidelines/Typography.md create mode 100644 docs/0.10.0/guidelines/Typography_docs.md create mode 100644 docs/0.10.0/home_content.md create mode 100644 docs/0.10.0/index.md create mode 100644 docs/0.10.0/index_content.md diff --git a/DEVELOP.md b/DEVELOP.md index 417a4f0d3..9f45a163f 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -18,6 +18,6 @@ repositories { ```groovy dependencies { - implementation 'com.orange.ods.android:ods-lib:0.9.0' + implementation 'com.orange.ods.android:ods-lib:0.10.0' } ``` diff --git a/changelog.md b/changelog.md index 03ccc67d4..fe7c0677a 100644 --- a/changelog.md +++ b/changelog.md @@ -5,7 +5,7 @@ All notable changes done in ODS library will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased](https://github.com/Orange-OpenSource/ods-android/compare/0.9.0...master) +## [0.10.0](https://github.com/Orange-OpenSource/ods-android/compare/0.9.0...0.10.0) - 2023-02-07 ### Added diff --git a/docs/0.10.0/404.html b/docs/0.10.0/404.html new file mode 100644 index 000000000..dd331eb8e --- /dev/null +++ b/docs/0.10.0/404.html @@ -0,0 +1,26 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
\ No newline at end of file diff --git a/docs/0.10.0/components/AppBarsBottom.md b/docs/0.10.0/components/AppBarsBottom.md new file mode 100644 index 000000000..c78807e84 --- /dev/null +++ b/docs/0.10.0/components/AppBarsBottom.md @@ -0,0 +1,167 @@ +--- +layout: detail +title: "App bars: bottom" +description: A bottom app bar displays navigation and key actions at the bottom of mobile screens. +--- + +--- + +**Page Summary** + +* [Specifications references](#specifications-references) +* [Accessibility](#accessibility) +* [Implementation](#implementation) +* [Component specific tokens](#component-specific-tokens) + +--- + +## Specifications references + +- [Design System Manager - App bars](https://system.design.orange.com/0c1af118d/p/23e0e6-app-bars/b/620966) +- [Material Design - App bars: bottom](https://material.io/components/app-bars-bottom) +- *Technical documentation soon available* + +## Accessibility + +Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/android/development/) + +Android's bottom app bar component APIs provide support for the navigation icon, +action items, overflow menu and more for informing the user as to what each +action performs. While optional, their use is strongly encouraged. + +**Content descriptions** + +When using icons for navigation icons, action items and other elements of bottom +app bars, you should set a content description on them so that screen readers +like TalkBack are able to announce their purpose or action, if any. + +For an overall content description of the bottom app bar, set an +`android:contentDescription` or use the `setContentDescription` method on the +`BottomAppBar`. + +For the navigation icon, this can be achieved via the +`app:navigationContentDescription` attribute or +`setNavigationContentDescription` method. + +For action items and items within the overflow menu, the content description +needs to be set in the menu: + +```xml + + + + +``` + +## Implementation + +Bottom app bars provide access to a bottom navigation drawer and up to four +actions, including the floating action button. + +> **Jetpack Compose implementation** + +*Not available yet* + +> **XML implementation** + +API and source code: + +* `CoordinatorLayout`: [Class definition](https://developer.android.com/reference/androidx/coordinatorlayout/widget/CoordinatorLayout) +* `BottomAppBar`: [Class definition](https://developer.android.com/reference/com/google/android/material/bottomappbar/BottomAppBar), [Class source](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/bottomappbar/BottomAppBar.java) +* `FloatingActionButton`: [Class definition](https://developer.android.com/reference/com/google/android/material/floatingactionbutton/FloatingActionButton), [Class source](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/floatingactionbutton/FloatingActionButton.java) + +In the layout: + +```xml + + + + + + + + + + + + + + +``` + +In `menu/bottom_app_bar.xml`: + +```xml + + + + + + + +``` + +In menu/navigation icon drawables: + +```xml + + +``` + +In code: + +```kotlin +bottomAppBar.setNavigationOnClickListener { + // Handle navigation icon press +} + +bottomAppBar.setOnMenuItemClickListener { menuItem -> + when (menuItem.itemId) { + R.id.search -> { + // Handle search icon press + true + } + R.id.more -> { + // Handle more item (inside overflow menu) press + true + } + else -> false + } +} +``` + +## Component specific tokens + +_Soon available_ diff --git a/docs/0.10.0/components/AppBarsBottom_docs.md b/docs/0.10.0/components/AppBarsBottom_docs.md new file mode 100644 index 000000000..4566c033f --- /dev/null +++ b/docs/0.10.0/components/AppBarsBottom_docs.md @@ -0,0 +1,4 @@ +--- +layout: main +content_page: AppBarsBottom.md +--- \ No newline at end of file diff --git a/docs/0.10.0/components/AppBarsTop.md b/docs/0.10.0/components/AppBarsTop.md new file mode 100644 index 000000000..15ec4ffaa --- /dev/null +++ b/docs/0.10.0/components/AppBarsTop.md @@ -0,0 +1,269 @@ +--- +layout: detail +title: "App bars: top" +description: Top app bars display information and actions relating to the current screen. +--- + +--- + +**Page Summary** + +* [Specifications references](#specifications-references) +* [Accessibility](#accessibility) +* [Implementation](#implementation) +* [Extras](#extras) + * [Overflow menu](#overflow-menu) +* [Component specific tokens](#component-specific-tokens) + +--- + +## Specifications references + +- [Design System Manager - App bars](https://system.design.orange.com/0c1af118d/p/23e0e6-app-bars/b/620966) +- [Material Design - App bars: top](https://material.io/components/app-bars-top/) +- Technical documentation soon available + +## Accessibility + +Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/android/development/) + +Android's top app bar component APIs provide support for the navigation icon, +action items, overflow menu and more for informing the user as to what each +action performs. While optional, their use is strongly encouraged. + +**Content descriptions** + +When using icons for navigation icons, action items and other elements of top +app bars, you should set a content description on them so that screen readers +like TalkBack are able to announce their purpose or action, if any. + +For an overall content description of the top app bar, set an +`android:contentDescription` or use the `setContentDescription` method on the +`MaterialToolbar`. + +For the navigation icon, this can be achieved via the +`app:navigationContentDescription` attribute or +`setNavigationContentDescription` method. + +For action items and items within the overflow menu, the content description +needs to be set in the menu: + +```xml + + + + +``` + +For images within top app bars, set an `android:contentDescription` +or use the `setContentDescription` method on the `ImageView`. + +## Implementation + +> **Jetpack Compose implementation** + +Add `OdsTopAppBar` composable to your Scaffold topBar as follow: + +```kotlin +OdsTopAppBar( + title = { + Text(text = "Title") + }, + navigationIcon = { + Icon( + painter = painterResource(id = R.drawable.ic_back), + contentDescription = "content description" + ) + }, + onNavigationIconClick = { + // Do something + }, + actions = { + OdsTopAppBarActionButton( + onClick = { }, + painter = painterResource(id = R.drawable.ic_share), + contentDescription = "content description" + ) // Each action should be an `OdsTopAppBarActionButton`. They are displayed in a `Row`, so icons inside will be placed horizontally. + } +) +``` + +Note: By default, the `OdsTopAppBar` is elevated but you can set `elevated` parameter to `false` if you don't want any shadow below it (for example if you want to display tabs below). + +> **XML implementation** + +API and source code: + +* `CoordinatorLayout`: [Class definition](https://developer.android.com/reference/androidx/coordinatorlayout/widget/CoordinatorLayout) +* `AppBarLayout`: [Class definition](https://developer.android.com/reference/com/google/android/material/appbar/AppBarLayout), [Class source](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/appbar/AppBarLayout.java) +* `MaterialToolbar`: [Class definition](https://developer.android.com/reference/com/google/android/material/appbar/MaterialToolbar), [Class source](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/appbar/MaterialToolbar.java) +* `CollapsingToolbarLayout`: [Class definition](https://developer.android.com/reference/com/google/android/material/appbar/CollapsingToolbarLayout), [Class source](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/appbar/CollapsingToolbarLayout.java) + +In the layout: + +```xml + + + + + + + + + + + + + + + + +``` + +In `@menu/top_app_bar.xml`: + +```xml + + + + + + + + + +``` + +In menu/navigation icons: + +```xml + + +``` + +In code: + +```kotlin +topAppBar.setNavigationOnClickListener { + // Handle navigation icon press +} + +topAppBar.setOnMenuItemClickListener { menuItem -> + when (menuItem.itemId) { + R.id.favorite -> { + // Handle favorite icon press + true + } + R.id.search -> { + // Handle search icon press + true + } + R.id.more -> { + // Handle more item (inside overflow menu) press + true + } + else -> false + } +} +``` + +_**Applying scrolling behavior to the top app bar**_ + +The following example shows the top app bar positioned at the same elevation as +content. Upon scroll, it increases elevation and lets content scroll behind it. + +In the layout: + +```xml + + + + + + + + + +``` + +_**Raised top app bar**_ + +If you need to have a top app bar with some elevation you can set the `@style/Widget.Orange.Toolbar.Raised` + +```xml + + + + + + + + + +``` + +## Extras + +### Overflow menu + +![Overflow menu light](images/app_bar_top_overflow_menu_light.png) +![Overflow menu dark](images/app_bar_top_overflow_menu_dark.png) + +You can easily add an overflow menu to your top app bar by using the `OdsTopAppBarOverflowMenuBox` composable as follow: + +```kotlin +OdsTopAppBarOverflowMenuBox(overflowIconContentDescription = "more actions") { + OdsDropdownMenuItem( + text = "account", + onClick = { + // Do something + } + ) + OdsDropdownMenuItem( + text = "settings", + onClick = { + // Do something + } + ) +} +``` + +## Component specific tokens + +_Soon available_ diff --git a/docs/0.10.0/components/AppBarsTop_docs.md b/docs/0.10.0/components/AppBarsTop_docs.md new file mode 100644 index 000000000..1afad632b --- /dev/null +++ b/docs/0.10.0/components/AppBarsTop_docs.md @@ -0,0 +1,4 @@ +--- +layout: main +content_page: AppBarsTop.md +--- \ No newline at end of file diff --git a/docs/0.10.0/components/Buttons.md b/docs/0.10.0/components/Buttons.md new file mode 100644 index 000000000..2f00f5ff6 --- /dev/null +++ b/docs/0.10.0/components/Buttons.md @@ -0,0 +1,297 @@ +--- +layout: detail +title: Buttons +description: Buttons allow users to take actions, and make choices, with a single tap. +--- + +--- + +**Page Summary** + +* [Specifications references](#specifications-references) +* [Accessibility](#accessibility) +* [Variants](#variants) + * [Text button](#text-button) + * [Outlined button](#outlined-button) + * [Contained button](#contained-button) + * [Toggle button](#toggle-button) + * [Icon button](#icon-button) +* [Component specific tokens](#component-specific-tokens) + +--- + +## Specifications references + +- [Design System Manager - Buttons](https://system.design.orange.com/0c1af118d/p/06a393-buttons/b/530521) +- [Material Design - Buttons](https://material.io/components/buttons/) +- Technical documentation soon available + +## Accessibility + +Please follow [accessibility criteria for development](https://a11y-guidelines.orange.com/en/mobile/android/development/) + +Buttons support content labeling for accessibility and are readable by most screen readers, such as +TalkBack. Text rendered in buttons is automatically provided to accessibility services. Additional +content labels are usually unnecessary. + +## Variants + +### Text button + +Text buttons are typically used for less-pronounced actions, including those located in dialogs and +cards. In cards, text buttons help maintain an emphasis on card content. + + ![TextButton](images/button_text_light.png) ![TextButton dark](images/button_text_dark.png) + +> **Jetpack Compose implementation** + +Use the `OdsTextButton` composable: + +```kotlin +OdsTextButton( + text = "Text button", + onClick = {}, + enabled = true, + icon = painterResource(R.drawable.ic_coffee), // Optional, line can be removed if you don't need any icon + style = OdsTextButtonStyle.Primary +) +``` + +> **XML implementation** + +To create a Text Button using Orange theme you will need to apply +style `@style/Widget.Orange.Button.Text` on your `Button` layout + +In the layout: + +```xml +