From 232921b60ec0907480499fb72cacf6bad8deb826 Mon Sep 17 00:00:00 2001 From: Kenia <19161242+kaxcode@users.noreply.github.com> Date: Tue, 23 Mar 2021 09:22:09 -0400 Subject: [PATCH] ui: Add a README to the new Certificate component (#9908) --- .../app/components/certificate/README.mdx | 31 +++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 ui/packages/consul-ui/app/components/certificate/README.mdx diff --git a/ui/packages/consul-ui/app/components/certificate/README.mdx b/ui/packages/consul-ui/app/components/certificate/README.mdx new file mode 100644 index 0000000000..34dd1bb359 --- /dev/null +++ b/ui/packages/consul-ui/app/components/certificate/README.mdx @@ -0,0 +1,31 @@ +# Certificate + +```hbs preview-template + +``` + +### Arguments + +| Argument | Type | Default | Description | +| --- | --- | --- | --- | +| `item` | `String` | | The certificate as a string to be displayed and copied | +| `name` | `String` | | The 'Name' of the certificate to be displayed and copied. Mainly used for giving feedback to the user. | + +This component has the following: +- a copy button +- a visibility button to show and hide certificate +- a hidden and visible display of the certificate + +### See + +- [Component Source Code](./index.js) +- [Template Source Code](./index.hbs) + +---