From c216f77fe53fbdb27aded528d5867a8ca1e67616 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-Fran=C3=A7ois=20Allaire?= Date: Mon, 7 Oct 2024 16:49:38 -0400 Subject: [PATCH] docs(atomic): document component --- .../atomic-insight-result-attach-to-case.tsx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packages/atomic/src/components/insight/atomic-insight-result-attach-to-case/atomic-insight-result-attach-to-case.tsx b/packages/atomic/src/components/insight/atomic-insight-result-attach-to-case/atomic-insight-result-attach-to-case.tsx index 201bf20f87..d848e7ae16 100644 --- a/packages/atomic/src/components/insight/atomic-insight-result-attach-to-case/atomic-insight-result-attach-to-case.tsx +++ b/packages/atomic/src/components/insight/atomic-insight-result-attach-to-case/atomic-insight-result-attach-to-case.tsx @@ -25,6 +25,14 @@ export interface InsightResultAttachToCaseEvent { } /** * @internal + * The `atomic-insight-result-attach-to-case` component can be nested inside a `atomic-insight-result-actions` to render an interactive button that will emit an `atomic/insight/attachToCase/attach` or `atomic/insight/attachToCase/detach` JavaScript event, based on its current state, when clicked. + * + * The component can also be included inside a result template, typically with the `readOnly="true"` attribute, to indicate whether a result is attached to the current case. + * + * @part result-action-container - The result action container, when the `readOnly` prop is set to `false`. + * @part result-action-button - The result action button, when the `readOnly` prop is set to `false`. + * @part result-action-icon - The result action icon, when the `readOnly` prop is set to `false`. + * @part icon The icon, when the `readOnly` prop is set to `true`. */ @Component({ tag: 'atomic-insight-result-attach-to-case',