From 0bcad2949c415b0e150f07a23f1fbca93d35787e Mon Sep 17 00:00:00 2001 From: Tao Zhou Date: Fri, 13 Mar 2020 17:48:58 +0100 Subject: [PATCH] Add a README to embed folder to explain why and what are inside of it Change-Id: I10b9db2a0f2bf641a630ddaf0a766b0bc44b1d51 --- polygerrit-ui/app/embed/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 polygerrit-ui/app/embed/README.md diff --git a/polygerrit-ui/app/embed/README.md b/polygerrit-ui/app/embed/README.md new file mode 100644 index 0000000000..e147007661 --- /dev/null +++ b/polygerrit-ui/app/embed/README.md @@ -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: + +``` + +``` + +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`. \ No newline at end of file