summaryrefslogtreecommitdiff
path: root/chromium/ui/webui/resources/cr_components/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'chromium/ui/webui/resources/cr_components/README.md')
-rw-r--r--chromium/ui/webui/resources/cr_components/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/chromium/ui/webui/resources/cr_components/README.md b/chromium/ui/webui/resources/cr_components/README.md
new file mode 100644
index 00000000000..a4ea0138a7d
--- /dev/null
+++ b/chromium/ui/webui/resources/cr_components/README.md
@@ -0,0 +1,12 @@
+This directory contains complex Polymer web components for Web UI. They may be
+shared between Settings, login, stand alone dialogs, etc.
+
+These components are allowed to use I18nBehavior. The Web UI hosting these
+components is expected to provide loadTimeData with any necessary strings.
+TODO(stevenjb/dschuyler): Add support for i18n{} substitution.
+
+These components may also use chrome and extension APIs, e.g. chrome.send
+(through a browser proxy) or chrome.settingsPrivate. The C++ code hosting the
+component is expected to handle these calls.
+
+For simpler components with no I18n or chrome dependencies, see cr_elements.