You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update all prop descriptions with official Base UI documentation
- Source all prop descriptions from official Base UI JSON documentation files
- Update PreviewCardRoot, PreviewCardTrigger, PreviewCardBackdrop, PreviewCardPortal, PreviewCardPositioner, PreviewCardPopup, and PreviewCardArrow components
- Add render prop descriptions for all components that support it
- Include default values where specified in official docs
- Follow established comment format for consistency
- Maintain existing functionality while improving documentation accuracy
Co-Authored-By: Carlos Cutillas <[email protected]>
# How long to wait before opening the preview card on hover. Specified in milliseconds. Defaults to 600.
58
+
# How long to wait before the preview card opens. Specified in milliseconds. Defaults to 600.
59
59
delay: Var[int]
60
60
61
61
# How long to wait before closing the preview card that was opened on hover. Specified in milliseconds. Defaults to 300.
@@ -73,7 +73,6 @@ class PreviewCardTrigger(PreviewCardBaseComponent):
73
73
74
74
tag="PreviewCard.Trigger"
75
75
76
-
# The render prop
77
76
render_: Var[Component]
78
77
79
78
@classmethod
@@ -89,7 +88,6 @@ class PreviewCardBackdrop(PreviewCardBaseComponent):
89
88
90
89
tag="PreviewCard.Backdrop"
91
90
92
-
# The render prop
93
91
render_: Var[Component]
94
92
95
93
@classmethod
@@ -108,7 +106,7 @@ class PreviewCardPortal(PreviewCardBaseComponent):
108
106
# A parent element to render the portal element into.
109
107
container: Var[str]
110
108
111
-
# Whether to keep the portal mounted in the DOM while the popup is hidden. Defaults to False.
109
+
# Whether to keep the portal mounted in the DOM while the popup is hidden. Defaults to false.
112
110
keep_mounted: Var[bool]
113
111
114
112
@@ -117,16 +115,19 @@ class PreviewCardPositioner(PreviewCardBaseComponent):
117
115
118
116
tag="PreviewCard.Positioner"
119
117
120
-
# How to align the popup relative to the specified side. Defaults to "center".
118
+
# Determines how to handle collisions when positioning the popup.
119
+
collision_avoidance: Var[str]
120
+
121
+
# How to align the popup relative to the specified side. Defaults to center.
121
122
align: Var[LiteralAlign]
122
123
123
-
# Additional offset along the alignment axis in pixels. Defaults to 0.
124
+
# Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the popup. Defaults to 0.
124
125
align_offset: Var[int]
125
126
126
-
# Which side of the anchor element to align the popup against. May automatically change to avoid collisions. Defaults to "bottom".
127
+
# Which side of the anchor element to align the popup against. May automatically change to avoid collisions. Defaults to bottom.
127
128
side: Var[LiteralSide]
128
129
129
-
# Distance between the anchor and the popup in pixels. Defaults to 0.
130
+
# Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the popup. Defaults to 0.
130
131
side_offset: Var[int]
131
132
132
133
# Minimum distance to maintain between the arrow and the edges of the popup. Use it to prevent the arrow element from hanging out of the rounded corners of a popup. Defaults to 5.
@@ -135,25 +136,21 @@ class PreviewCardPositioner(PreviewCardBaseComponent):
135
136
# An element to position the popup against. By default, the popup will be positioned against the trigger.
136
137
anchor: Var[str]
137
138
138
-
# An element or a rectangle that delimits the area that the popup is confined to. Defaults to "clipping-ancestors".
139
+
# An element or a rectangle that delimits the area that the popup is confined to. Defaults to clipping-ancestors.
139
140
collision_boundary: Var[str]
140
141
141
142
# Additional space to maintain from the edge of the collision boundary. Defaults to 5.
142
143
collision_padding: Var[int|list[int]]
143
144
144
-
# Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. Defaults to False.
145
+
# Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. Defaults to false.
145
146
sticky: Var[bool]
146
147
147
-
# Determines which CSS position property to use. Defaults to "absolute".
148
+
# Determines which CSS position property to use. Defaults to absolute.
148
149
position_method: Var[LiteralPosition]
149
150
150
-
# Whether the popup tracks any layout shift of its positioning anchor. Defaults to True.
151
+
# Whether the popup tracks any layout shift of its positioning anchor. Defaults to true.
151
152
track_anchor: Var[bool]
152
153
153
-
# Determines how to handle collisions when positioning the popup.
154
-
collision_avoidance: Var[str]
155
-
156
-
# The render prop
157
154
render_: Var[Component]
158
155
159
156
@classmethod
@@ -170,7 +167,6 @@ class PreviewCardPopup(PreviewCardBaseComponent):
170
167
171
168
tag="PreviewCard.Popup"
172
169
173
-
# The render prop
174
170
render_: Var[Component]
175
171
176
172
@classmethod
@@ -186,7 +182,6 @@ class PreviewCardArrow(PreviewCardBaseComponent):
0 commit comments