Skip to content

Commit f875337

Browse files
feat: migrating facet manager documentation
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 291e15e commit f875337

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
import { Meta } from '@storybook/addon-docs/blocks';
2+
import * as AtomicFacetManagerStories from './atomic-facet-manager.new.stories';
3+
import { AtomicDocTemplate } from '../../../../storybook-utils/documentation/atomic-doc-template';
4+
5+
<Meta of={AtomicFacetManagerStories} />
6+
7+
<AtomicDocTemplate
8+
stories={AtomicFacetManagerStories}
9+
githubPath="search/atomic-facet-manager/atomic-facet-manager.ts"
10+
tagName="atomic-facet-manager"
11+
className="AtomicFacetManager"
12+
>
13+
14+
The `atomic-facet-manager` is designed to handle the removal and re-attachment of <a href="?path=/story/atomic-facet--default">facet</a> components
15+
to the DOM.
16+
This means that the [Stencil lifecycle](https://stenciljs.com/docs/component-lifecycle#component-lifecycle-methods) applies to the slotted facets.
17+
18+
If you <a href="https://docs.coveo.com/en/atomic/latest/usage/custom-web-components#custom-component-example">create your own custom facet component</a> and slot it inside of the `atomic-facet-manager`, it will have to be able to handle the Stencil reattachment lifecycle.
19+
Alternately, you can place your custom component outside of the `atomic-facet-manager`, in which case the Stencil lifecycle won’t apply.
20+
21+
</AtomicDocTemplate>

0 commit comments

Comments
 (0)