Skip to content

Commit 079fe04

Browse files
francoischalifoursarahdayan
authored andcommitted
docs(Panel): update options (#99)
* docs(Panel): update options * docs(panel): add mention of controlled mode
1 parent aba6bf3 commit 079fe04

File tree

1 file changed

+6
-2
lines changed
  • packages/instantsearch-specs/content/widgets

1 file changed

+6
-2
lines changed

packages/instantsearch-specs/content/widgets/panel.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ althtml2: |
4040
classes:
4141
- name: .ais-Panel
4242
description: the root div of the Panel
43+
- name: .ais-Panel--noRefinement
44+
description: the root div of the Panel with no refinements
4345
- name: .ais-Panel--collapsible
4446
description: the root div of the collapsible Panel
4547
- name: .ais-Panel--collapsed
@@ -59,6 +61,8 @@ options:
5961
description: Text to put before the widget
6062
- name: footer
6163
description: Text to put after the widget
62-
- name: collapsible
63-
description: Makes the panel collapsible
64+
- name: hidden
65+
description: Function that is called on each render to determine if the panel has to be hidden. It returns a boolean based on the render options. The returned boolean determine if the panel is hidden.
66+
- name: collapsed
67+
description: Function that makes the panel collapsible when defined. It returns a boolean based on the render options. The returned boolean determine if the panel is collapsed. Once the user interacts with the collapse button, this function isn't taken into account anymore.
6468
---

0 commit comments

Comments
 (0)