opendev/gerrit
Code Issues Proposed changes

Add a README to embed folder to explain why and what are inside of it

Browse Source 
Change-Id: I10b9db2a0f2bf641a630ddaf0a766b0bc44b1d51
This commit is contained in:
Tao Zhou
2020-03-13 17:48:58 +01:00
parent 8eb8ca1c54
commit 0bcad2949c
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
polygerrit-ui/app/embed/README.md Normal file
View File

@@ -0,0 +1,13 @@
This folder contains shared components that can be used independently from Gerrit.
### gr-diff
`gr-diff.html` is the `gr-diff` component used in gerrit to render diff. If you want to use it, feel free to import it and use it in your project as:
```
<gr-diff></gr-diff>
```
All supported attributes defined in `polygerrit-ui/app/elements/diff/gr-diff/gr-diff.js`, you can pass them by just assigning them to the `gr-app` element.
To customize the style of the diff, you can use `css variables`, all supported varibled defined in `polygerrit-ui/app/styles/themes/app-theme.html` and `polygerrit-ui/app/styles/themes/dark-theme.html`.