Skip to content

Commit 1940c83

Browse files
feat: Update readme with theme description (#415)
# [DCMAW-18949](https://govukverify.atlassian.net/browse/DCMAW-18949): Update README to align with design systems - Update readme with theme description ## Evidence of the change [//]: # (Screenshots / uploaded videos go here) ## Checklist ### Before creating the pull request - [x] Commit messages that conform to conventional commit messages. - [x] Ran the app locally ensuring it builds. - [x] Tests pass locally. - [x] Pull request has a clear title with a short description about the feature or update. - [ ] Created a `draft` pull request if it's not ready for review. ### Before the CODEOWNERS review the pull request - [x] Complete all Acceptance Criteria within Jira ticket. - [x] Self-review code. - [x] Successfully run changes on a testing device. - [x] Complete automated Testing: * [ ] Unit Tests. * [ ] Integration Tests. * [ ] Instrumentation / Emulator Tests. - [x] Review [Accessibility considerations]. - [ ] Handle PR comments. ### Before merging the pull request - [ ] [Sonar cloud report] passes inspections for your PR. - [ ] Resolve all comments. [Sonar cloud report]: https://sonarcloud.io/project/overview?id=di-mobile-android-ui [Accessibility considerations]: https://developer.android.com/guide/topics/ui/accessibility/testing [DCMAW-18949]: https://govukverify.atlassian.net/browse/DCMAW-18949?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
1 parent 055c13e commit 1940c83

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,17 @@ Libraries to provide some useful and generic UI components, pages and themes to
77

88
### Theme
99

10-
This library contains the `GdsTheme`, collecting the colour schemes, fonts/typography and some useful dimensions.
10+
This library contains:
11+
- The `GdsTheme`
12+
- Pre-defined colour objects in line with the GDS Design System
13+
- Day and night mode colour schemes
14+
- Typography text styles
15+
- Commonly used dimensions.
1116

1217
### Components
1318

1419
This library contains 'building blocks', smaller, reusable components - the only new components to be created should have full specs provided by the user centred design (UCD) team.
15-
All new components should be created in `componentsv2` module - `components` module will be deprecated and removed once all dependencies from other repositories have been removed.
20+
All new components should be created in `componentsv2` module
1621

1722
Components include:
1823

@@ -35,11 +40,12 @@ Components include:
3540
- GdsTopAppBar
3641
- GdsWarningText
3742
- GdsCard
43+
- CameraContent (componentsv2-camera submodule)
3844

3945
### Patterns
4046

4147
This library contains page patterns to help with the creation of similar styles of page. They use components from the `componentsv2` library to build larger patterns.
42-
All new components should be created in `patterns` module - `pages` module will be deprecated and removed once all dependencies from other repositories have been removed.
48+
All new components should be created in `patterns` module
4349

4450
Patterns include:
4551

@@ -49,6 +55,7 @@ Patterns include:
4955
- ErrorScreen
5056
- LeftAlignedScreen
5157
- LoadingScreen
58+
- QrScannerScreen (patterns-camera submodule)
5259

5360
## Installation
5461

0 commit comments

Comments
 (0)