Skip to content
This repository was archived by the owner on Oct 22, 2024. It is now read-only.

chore: add ui documentation#581

Merged
OGPoyraz merged 1 commit intomainfrom
chore/569-document-the-ui-storage-and-differences-to-the-state-storage
Mar 9, 2023
Merged

chore: add ui documentation#581
OGPoyraz merged 1 commit intomainfrom
chore/569-document-the-ui-storage-and-differences-to-the-state-storage

Conversation

@OGPoyraz
Copy link
Copy Markdown
Member

@OGPoyraz OGPoyraz commented Mar 3, 2023

Overview

Adds documentation for UI

@OGPoyraz OGPoyraz requested a review from a team March 3, 2023 15:07
@OGPoyraz OGPoyraz linked an issue Mar 3, 2023 that may be closed by this pull request
@OGPoyraz OGPoyraz force-pushed the chore/569-document-the-ui-storage-and-differences-to-the-state-storage branch 3 times, most recently from e38ba8d to 57d3033 Compare March 9, 2023 08:56
Partial Redux state is being persisted using `redux-persist` library. In order to see what is being persisted, see root reducer in `packages/app/src/ui/ducks/index.js`.

### UI State Migration
Persisted UI states might need to be migrated when the state structure changes. In order to do that, persisted reducers need to be migrated in to latest state structure. This is done by `redux-persist` library.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"in to latest" => "into latest"


## Styling
In order to keep the styling consistent with extension styling approach, we use scss modules. This allows us to use the same variables and mixins as the extension.
MetaMask Desktop styles are combined under `packages/app/src/ui/css/index.scss`. This file imports all the other components scss files which is used in the MM Desktop app.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

"which is used" => "which are used"

@OGPoyraz OGPoyraz force-pushed the chore/569-document-the-ui-storage-and-differences-to-the-state-storage branch from 57d3033 to a2424ff Compare March 9, 2023 10:55
@OGPoyraz OGPoyraz merged commit bbe8905 into main Mar 9, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Mar 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the UI storage (and differences to the state storage)

3 participants