@fluentui/react-card 9.0.0-alpha.8 → 9.0.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/CHANGELOG.json +919 -1
  2. package/CHANGELOG.md +259 -2
  3. package/README.md +3 -1
  4. package/Spec.md +523 -0
  5. package/assets/Card.png +0 -0
  6. package/assets/CardHeader.png +0 -0
  7. package/assets/CardPreview.png +0 -0
  8. package/assets/context-interaction-keyboard.png +0 -0
  9. package/assets/context-interaction-mouse.png +0 -0
  10. package/assets/context-narrator.png +0 -0
  11. package/assets/disabled-narrator.png +0 -0
  12. package/assets/disabled.png +0 -0
  13. package/assets/interactive-interaction-keyboard.png +0 -0
  14. package/assets/interactive-interaction-mouse.png +0 -0
  15. package/assets/interactive-narrator.png +0 -0
  16. package/assets/non-interactive-interaction-keyboard.png +0 -0
  17. package/assets/non-interactive-interaction-mouse.png +0 -0
  18. package/assets/non-interactive-narrator.png +0 -0
  19. package/assets/non-interactive-selectable-interaction-keyboard.png +0 -0
  20. package/assets/non-interactive-selectable-interaction-mouse.png +0 -0
  21. package/assets/selectable-interaction-keyboard.png +0 -0
  22. package/assets/selectable-interaction-mouse.png +0 -0
  23. package/assets/selectable-narrator.png +0 -0
  24. package/dist/react-card.d.ts +67 -142
  25. package/lib/Card.js.map +1 -1
  26. package/lib/CardFooter.js.map +1 -1
  27. package/lib/CardHeader.js.map +1 -1
  28. package/lib/CardPreview.js.map +1 -1
  29. package/lib/components/Card/Card.d.ts +3 -3
  30. package/lib/components/Card/Card.js +8 -8
  31. package/lib/components/Card/Card.js.map +1 -1
  32. package/lib/components/Card/Card.types.d.ts +9 -18
  33. package/lib/components/Card/Card.types.js.map +1 -1
  34. package/lib/components/Card/index.js.map +1 -1
  35. package/lib/components/Card/renderCard.d.ts +1 -1
  36. package/lib/components/Card/renderCard.js +8 -8
  37. package/lib/components/Card/renderCard.js.map +1 -1
  38. package/lib/components/Card/useCard.d.ts +3 -4
  39. package/lib/components/Card/useCard.js +23 -11
  40. package/lib/components/Card/useCard.js.map +1 -1
  41. package/lib/components/Card/useCardStyles.d.ts +2 -1
  42. package/lib/components/Card/useCardStyles.js +133 -24
  43. package/lib/components/Card/useCardStyles.js.map +1 -1
  44. package/lib/components/CardFooter/CardFooter.d.ts +2 -2
  45. package/lib/components/CardFooter/CardFooter.js +7 -7
  46. package/lib/components/CardFooter/CardFooter.js.map +1 -1
  47. package/lib/components/CardFooter/CardFooter.types.d.ts +8 -23
  48. package/lib/components/CardFooter/CardFooter.types.js.map +1 -1
  49. package/lib/components/CardFooter/index.js.map +1 -1
  50. package/lib/components/CardFooter/renderCardFooter.d.ts +1 -1
  51. package/lib/components/CardFooter/renderCardFooter.js +9 -9
  52. package/lib/components/CardFooter/renderCardFooter.js.map +1 -1
  53. package/lib/components/CardFooter/useCardFooter.d.ts +4 -9
  54. package/lib/components/CardFooter/useCardFooter.js +18 -17
  55. package/lib/components/CardFooter/useCardFooter.js.map +1 -1
  56. package/lib/components/CardFooter/useCardFooterStyles.d.ts +2 -1
  57. package/lib/components/CardFooter/useCardFooterStyles.js +9 -7
  58. package/lib/components/CardFooter/useCardFooterStyles.js.map +1 -1
  59. package/lib/components/CardHeader/CardHeader.d.ts +2 -2
  60. package/lib/components/CardHeader/CardHeader.js +7 -7
  61. package/lib/components/CardHeader/CardHeader.js.map +1 -1
  62. package/lib/components/CardHeader/CardHeader.types.d.ts +12 -39
  63. package/lib/components/CardHeader/CardHeader.types.js.map +1 -1
  64. package/lib/components/CardHeader/index.js.map +1 -1
  65. package/lib/components/CardHeader/renderCardHeader.d.ts +1 -1
  66. package/lib/components/CardHeader/renderCardHeader.js +13 -9
  67. package/lib/components/CardHeader/renderCardHeader.js.map +1 -1
  68. package/lib/components/CardHeader/useCardHeader.d.ts +4 -9
  69. package/lib/components/CardHeader/useCardHeader.js +35 -32
  70. package/lib/components/CardHeader/useCardHeader.js.map +1 -1
  71. package/lib/components/CardHeader/useCardHeaderStyles.d.ts +2 -1
  72. package/lib/components/CardHeader/useCardHeaderStyles.js +9 -7
  73. package/lib/components/CardHeader/useCardHeaderStyles.js.map +1 -1
  74. package/lib/components/CardPreview/CardPreview.d.ts +2 -2
  75. package/lib/components/CardPreview/CardPreview.js +7 -7
  76. package/lib/components/CardPreview/CardPreview.js.map +1 -1
  77. package/lib/components/CardPreview/CardPreview.types.d.ts +8 -23
  78. package/lib/components/CardPreview/CardPreview.types.js.map +1 -1
  79. package/lib/components/CardPreview/index.js.map +1 -1
  80. package/lib/components/CardPreview/renderCardPreview.d.ts +1 -1
  81. package/lib/components/CardPreview/renderCardPreview.js +9 -9
  82. package/lib/components/CardPreview/renderCardPreview.js.map +1 -1
  83. package/lib/components/CardPreview/useCardPreview.d.ts +4 -9
  84. package/lib/components/CardPreview/useCardPreview.js +18 -20
  85. package/lib/components/CardPreview/useCardPreview.js.map +1 -1
  86. package/lib/components/CardPreview/useCardPreviewStyles.d.ts +2 -1
  87. package/lib/components/CardPreview/useCardPreviewStyles.js +7 -10
  88. package/lib/components/CardPreview/useCardPreviewStyles.js.map +1 -1
  89. package/lib/index.js.map +1 -1
  90. package/lib-commonjs/Card.js +1 -1
  91. package/lib-commonjs/Card.js.map +1 -1
  92. package/lib-commonjs/CardFooter.js +1 -1
  93. package/lib-commonjs/CardFooter.js.map +1 -1
  94. package/lib-commonjs/CardHeader.js +1 -1
  95. package/lib-commonjs/CardHeader.js.map +1 -1
  96. package/lib-commonjs/CardPreview.js +1 -1
  97. package/lib-commonjs/CardPreview.js.map +1 -1
  98. package/lib-commonjs/components/Card/Card.d.ts +3 -3
  99. package/lib-commonjs/components/Card/Card.js +9 -9
  100. package/lib-commonjs/components/Card/Card.js.map +1 -1
  101. package/lib-commonjs/components/Card/Card.types.d.ts +9 -18
  102. package/lib-commonjs/components/Card/Card.types.js.map +1 -1
  103. package/lib-commonjs/components/Card/index.js +1 -1
  104. package/lib-commonjs/components/Card/index.js.map +1 -1
  105. package/lib-commonjs/components/Card/renderCard.d.ts +1 -1
  106. package/lib-commonjs/components/Card/renderCard.js +11 -12
  107. package/lib-commonjs/components/Card/renderCard.js.map +1 -1
  108. package/lib-commonjs/components/Card/useCard.d.ts +3 -4
  109. package/lib-commonjs/components/Card/useCard.js +26 -13
  110. package/lib-commonjs/components/Card/useCard.js.map +1 -1
  111. package/lib-commonjs/components/Card/useCardStyles.d.ts +2 -1
  112. package/lib-commonjs/components/Card/useCardStyles.js +138 -27
  113. package/lib-commonjs/components/Card/useCardStyles.js.map +1 -1
  114. package/lib-commonjs/components/CardFooter/CardFooter.d.ts +2 -2
  115. package/lib-commonjs/components/CardFooter/CardFooter.js +8 -8
  116. package/lib-commonjs/components/CardFooter/CardFooter.js.map +1 -1
  117. package/lib-commonjs/components/CardFooter/CardFooter.types.d.ts +8 -23
  118. package/lib-commonjs/components/CardFooter/CardFooter.types.js.map +1 -1
  119. package/lib-commonjs/components/CardFooter/index.js +1 -1
  120. package/lib-commonjs/components/CardFooter/index.js.map +1 -1
  121. package/lib-commonjs/components/CardFooter/renderCardFooter.d.ts +1 -1
  122. package/lib-commonjs/components/CardFooter/renderCardFooter.js +12 -14
  123. package/lib-commonjs/components/CardFooter/renderCardFooter.js.map +1 -1
  124. package/lib-commonjs/components/CardFooter/useCardFooter.d.ts +4 -9
  125. package/lib-commonjs/components/CardFooter/useCardFooter.js +21 -20
  126. package/lib-commonjs/components/CardFooter/useCardFooter.js.map +1 -1
  127. package/lib-commonjs/components/CardFooter/useCardFooterStyles.d.ts +2 -1
  128. package/lib-commonjs/components/CardFooter/useCardFooterStyles.js +13 -11
  129. package/lib-commonjs/components/CardFooter/useCardFooterStyles.js.map +1 -1
  130. package/lib-commonjs/components/CardHeader/CardHeader.d.ts +2 -2
  131. package/lib-commonjs/components/CardHeader/CardHeader.js +8 -8
  132. package/lib-commonjs/components/CardHeader/CardHeader.js.map +1 -1
  133. package/lib-commonjs/components/CardHeader/CardHeader.types.d.ts +12 -39
  134. package/lib-commonjs/components/CardHeader/CardHeader.types.js.map +1 -1
  135. package/lib-commonjs/components/CardHeader/index.js +1 -1
  136. package/lib-commonjs/components/CardHeader/index.js.map +1 -1
  137. package/lib-commonjs/components/CardHeader/renderCardHeader.d.ts +1 -1
  138. package/lib-commonjs/components/CardHeader/renderCardHeader.js +16 -14
  139. package/lib-commonjs/components/CardHeader/renderCardHeader.js.map +1 -1
  140. package/lib-commonjs/components/CardHeader/useCardHeader.d.ts +4 -9
  141. package/lib-commonjs/components/CardHeader/useCardHeader.js +39 -36
  142. package/lib-commonjs/components/CardHeader/useCardHeader.js.map +1 -1
  143. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.d.ts +2 -1
  144. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.js +14 -12
  145. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.js.map +1 -1
  146. package/lib-commonjs/components/CardPreview/CardPreview.d.ts +2 -2
  147. package/lib-commonjs/components/CardPreview/CardPreview.js +8 -8
  148. package/lib-commonjs/components/CardPreview/CardPreview.js.map +1 -1
  149. package/lib-commonjs/components/CardPreview/CardPreview.types.d.ts +8 -23
  150. package/lib-commonjs/components/CardPreview/CardPreview.types.js.map +1 -1
  151. package/lib-commonjs/components/CardPreview/index.js +1 -1
  152. package/lib-commonjs/components/CardPreview/index.js.map +1 -1
  153. package/lib-commonjs/components/CardPreview/renderCardPreview.d.ts +1 -1
  154. package/lib-commonjs/components/CardPreview/renderCardPreview.js +12 -14
  155. package/lib-commonjs/components/CardPreview/renderCardPreview.js.map +1 -1
  156. package/lib-commonjs/components/CardPreview/useCardPreview.d.ts +4 -9
  157. package/lib-commonjs/components/CardPreview/useCardPreview.js +21 -23
  158. package/lib-commonjs/components/CardPreview/useCardPreview.js.map +1 -1
  159. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.d.ts +2 -1
  160. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.js +11 -14
  161. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.js.map +1 -1
  162. package/lib-commonjs/index.js +1 -1
  163. package/lib-commonjs/index.js.map +1 -1
  164. package/package.json +20 -12
  165. package/lib/common/isConformant.d.ts +0 -4
  166. package/lib/common/isConformant.js +0 -11
  167. package/lib/common/isConformant.js.map +0 -1
  168. package/lib-commonjs/common/isConformant.d.ts +0 -4
  169. package/lib-commonjs/common/isConformant.js +0 -22
  170. package/lib-commonjs/common/isConformant.js.map +0 -1
@@ -1,261 +1,186 @@
1
- import type { ComponentPropsCompat } from '@fluentui/react-utilities';
2
- import type { ComponentStateCompat } from '@fluentui/react-utilities';
1
+ import type { ComponentProps } from '@fluentui/react-utilities';
2
+ import type { ComponentState } from '@fluentui/react-utilities';
3
+ import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
4
  import * as React_2 from 'react';
4
- import type { ShorthandPropsCompat } from '@fluentui/react-utilities';
5
+ import type { Slot } from '@fluentui/react-utilities';
5
6
 
6
7
  /**
7
- * Component to provide scaffolding for hosting actions and content for a single topic within a card sized object.
8
+ * A card provides scaffolding for hosting actions and content for a single topic.
8
9
  */
9
- export declare const Card: React_2.ForwardRefExoticComponent<CardProps & React_2.RefAttributes<HTMLElement>>;
10
+ export declare const Card: ForwardRefComponent<CardProps>;
10
11
 
11
- /**
12
- * Names of CardProps that have a default value in useCard
13
- */
14
- export declare type CardDefaultedProps = never;
12
+ export declare const cardClassName = "fui-Card";
13
+
14
+ export declare type CardCommons = {
15
+ appearance: 'filled' | 'filled-alternative' | 'outline' | 'subtle';
16
+ };
15
17
 
16
18
  /**
17
19
  * Component to render Button actions in a Card component.
18
20
  */
19
- export declare const CardFooter: React_2.ForwardRefExoticComponent<CardFooterProps & React_2.RefAttributes<HTMLElement>>;
21
+ export declare const CardFooter: ForwardRefComponent<CardFooterProps>;
20
22
 
21
- /**
22
- * Names of CardFooterProps that have a default value in useCardFooter
23
- */
24
- export declare type CardFooterDefaultedProps = never;
23
+ export declare const cardFooterClassName = "fui-CardFooter";
25
24
 
26
25
  /**
27
- * CardFooter Props
26
+ * CardFooter props
28
27
  */
29
- export declare interface CardFooterProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
30
- /**
31
- * Actions slot
32
- */
33
- action?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
34
- }
28
+ export declare type CardFooterProps = ComponentProps<CardFooterSlots>;
35
29
 
36
- /**
37
- * Names of the shorthand properties in CardFooterProps
38
- */
39
- export declare type CardFooterShorthandProps = 'action';
40
-
41
- /**
42
- * Array of all shorthand properties listed in CardFooterShorthandProps
43
- */
44
- export declare const cardFooterShorthandProps: CardFooterShorthandProps[];
30
+ export declare type CardFooterSlots = {
31
+ root: Slot<'div'>;
32
+ action?: Slot<'div'>;
33
+ };
45
34
 
46
35
  /**
47
36
  * State used in rendering CardFooter
48
37
  */
49
- export declare interface CardFooterState extends ComponentStateCompat<CardFooterProps, CardFooterShorthandProps, CardFooterDefaultedProps> {
50
- /**
51
- * Ref to the root element
52
- */
53
- ref: React_2.Ref<HTMLElement>;
54
- }
38
+ export declare type CardFooterState = ComponentState<CardFooterSlots>;
55
39
 
56
40
  /**
57
41
  * Component to render an image, text and an action in a Card component.
58
42
  */
59
- export declare const CardHeader: React_2.ForwardRefExoticComponent<CardHeaderProps & React_2.RefAttributes<HTMLElement>>;
60
-
61
- /**
62
- * Names of CardHeaderProps that have a default value in useCardHeader
63
- */
64
- export declare type CardHeaderDefaultedProps = never;
43
+ export declare const CardHeader: ForwardRefComponent<CardHeaderProps>;
65
44
 
66
- /**
67
- * CardHeader Props
68
- */
69
- export declare interface CardHeaderProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
70
- /**
71
- * Image slot
72
- */
73
- image: ShorthandPropsCompat<React_2.ImgHTMLAttributes<HTMLImageElement>>;
74
- /**
75
- * Content slot, wrapper of the header and description slots
76
- */
77
- content?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
78
- /**
79
- * Header title slot
80
- */
81
- header: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
82
- /**
83
- * Description slot
84
- */
85
- description: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
86
- /**
87
- * Actions slot
88
- */
89
- action?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
90
- }
45
+ export declare const cardHeaderClassName = "fui-CardHeader";
91
46
 
92
47
  /**
93
- * Names of the shorthand properties in CardHeaderProps
48
+ * CardHeader props
94
49
  */
95
- export declare type CardHeaderShorthandProps = 'image' | 'content' | 'header' | 'description' | 'action';
50
+ export declare type CardHeaderProps = ComponentProps<Partial<CardHeaderSlots>>;
96
51
 
97
- /**
98
- * Array of all shorthand properties listed in CardHeaderShorthandProps
99
- */
100
- export declare const cardHeaderShorthandPropsCompat: CardHeaderShorthandProps[];
52
+ export declare type CardHeaderSlots = {
53
+ root: Slot<'div'>;
54
+ image: Slot<'div'>;
55
+ content?: Slot<'div'>;
56
+ header: Slot<'span'>;
57
+ description: Slot<'span'>;
58
+ action?: Slot<'div'>;
59
+ };
101
60
 
102
61
  /**
103
62
  * State used in rendering CardHeader
104
63
  */
105
- export declare interface CardHeaderState extends ComponentStateCompat<CardHeaderProps, CardHeaderShorthandProps> {
106
- /**
107
- * Ref to the root element
108
- */
109
- ref: React_2.Ref<HTMLElement>;
110
- }
64
+ export declare type CardHeaderState = ComponentState<CardHeaderSlots>;
111
65
 
112
66
  /**
113
67
  * Component to render image previews of documents or articles in a Card component.
114
68
  */
115
- export declare const CardPreview: React_2.ForwardRefExoticComponent<CardPreviewProps & React_2.RefAttributes<HTMLElement>>;
69
+ export declare const CardPreview: ForwardRefComponent<CardPreviewProps>;
116
70
 
117
- /**
118
- * Names of CardPreviewProps that have a default value in useCardPreview
119
- */
120
- export declare type CardPreviewDefaultedProps = never;
71
+ export declare const cardPreviewClassName = "fui-CardPreview";
121
72
 
122
73
  /**
123
- * CardPreview Props
74
+ * CardPreview props
124
75
  */
125
- export declare interface CardPreviewProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
126
- /**
127
- * Image slot
128
- */
129
- logo?: ShorthandPropsCompat<React_2.ImgHTMLAttributes<HTMLImageElement>>;
130
- }
76
+ export declare type CardPreviewProps = ComponentProps<CardPreviewSlots>;
131
77
 
132
- /**
133
- * Names of the shorthand properties in CardPreviewProps
134
- */
135
- export declare type CardPreviewShorthandProps = 'logo';
136
-
137
- /**
138
- * Array of all shorthand properties listed in CardPreviewShorthandProps
139
- */
140
- export declare const cardPreviewShorthandPropsCompat: CardPreviewShorthandProps[];
78
+ export declare type CardPreviewSlots = {
79
+ root: Slot<'div'>;
80
+ logo?: Slot<'div'>;
81
+ };
141
82
 
142
83
  /**
143
84
  * State used in rendering CardPreview
144
85
  */
145
- export declare interface CardPreviewState extends ComponentStateCompat<CardPreviewProps, CardPreviewShorthandProps, CardPreviewDefaultedProps> {
146
- /**
147
- * Ref to the root element
148
- */
149
- ref: React_2.Ref<HTMLElement>;
150
- }
86
+ export declare type CardPreviewState = ComponentState<CardPreviewSlots>;
151
87
 
152
88
  /**
153
89
  * Card Props
154
90
  */
155
- export declare interface CardProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
156
- }
91
+ export declare type CardProps = ComponentProps<CardSlots> & Partial<CardCommons>;
157
92
 
158
- /**
159
- * Names of the shorthand properties in CardProps
160
- */
161
- export declare type CardShorthandProps = never;
93
+ export declare type CardSlots = {
94
+ root: Slot<'div'>;
95
+ };
162
96
 
163
97
  /**
164
98
  * State used in rendering Card
165
99
  */
166
- export declare interface CardState extends CardProps, ComponentStateCompat<CardProps, CardShorthandProps, CardDefaultedProps> {
167
- /**
168
- * Ref to the root element
169
- */
170
- ref: React_2.Ref<HTMLElement>;
171
- }
100
+ export declare type CardState = ComponentState<CardSlots> & CardCommons;
172
101
 
173
102
  /**
174
103
  * Render the final JSX of Card
175
104
  */
176
- export declare const renderCard: (state: CardState) => JSX.Element;
105
+ export declare const renderCard_unstable: (state: CardState) => JSX.Element;
177
106
 
178
107
  /**
179
108
  * Render the final JSX of CardFooter
180
109
  */
181
- export declare const renderCardFooter: (state: CardFooterState) => JSX.Element;
110
+ export declare const renderCardFooter_unstable: (state: CardFooterState) => JSX.Element;
182
111
 
183
112
  /**
184
113
  * Render the final JSX of CardHeader
185
114
  */
186
- export declare const renderCardHeader: (state: CardHeaderState) => JSX.Element;
115
+ export declare const renderCardHeader_unstable: (state: CardHeaderState) => JSX.Element;
187
116
 
188
117
  /**
189
118
  * Render the final JSX of CardPreview
190
119
  */
191
- export declare const renderCardPreview: (state: CardPreviewState) => JSX.Element;
120
+ export declare const renderCardPreview_unstable: (state: CardPreviewState) => JSX.Element;
192
121
 
193
122
  /**
194
123
  * Create the state required to render Card.
195
124
  *
196
- * The returned state can be modified with hooks such as useCardStyles,
197
- * before being passed to renderCard.
125
+ * The returned state can be modified with hooks such as useCardStyles_unstable,
126
+ * before being passed to renderCard_unstable.
198
127
  *
199
128
  * @param props - props from this instance of Card
200
129
  * @param ref - reference to root HTMLElement of Card
201
- * @param defaultProps - (optional) default prop values provided by the implementing type
202
130
  */
203
- export declare const useCard: (props: CardProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardProps | undefined) => CardState;
131
+ export declare const useCard_unstable: (props: CardProps, ref: React_2.Ref<HTMLElement>) => CardState;
204
132
 
205
133
  /**
206
134
  * Create the state required to render CardFooter.
207
135
  *
208
- * The returned state can be modified with hooks such as useCardFooterStyles,
209
- * before being passed to renderCardFooter.
136
+ * The returned state can be modified with hooks such as useCardFooterStyles_unstable,
137
+ * before being passed to renderCardFooter_unstable.
210
138
  *
211
139
  * @param props - props from this instance of CardFooter
212
140
  * @param ref - reference to root HTMLElement of CardFooter
213
- * @param defaultProps - (optional) default prop values provided by the implementing type
214
141
  */
215
- export declare const useCardFooter: (props: CardFooterProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardFooterProps | undefined) => CardFooterState;
142
+ export declare const useCardFooter_unstable: (props: CardFooterProps, ref: React_2.Ref<HTMLElement>) => CardFooterState;
216
143
 
217
144
  /**
218
145
  * Apply styling to the CardFooter slots based on the state
219
146
  */
220
- export declare const useCardFooterStyles: (state: CardFooterState) => CardFooterState;
147
+ export declare const useCardFooterStyles_unstable: (state: CardFooterState) => CardFooterState;
221
148
 
222
149
  /**
223
150
  * Create the state required to render CardHeader.
224
151
  *
225
- * The returned state can be modified with hooks such as useCardHeaderStyles,
226
- * before being passed to renderCardHeader.
152
+ * The returned state can be modified with hooks such as useCardHeaderStyles_unstable,
153
+ * before being passed to renderCardHeader_unstable.
227
154
  *
228
155
  * @param props - props from this instance of CardHeader
229
156
  * @param ref - reference to root HTMLElement of CardHeader
230
- * @param defaultProps - (optional) default prop values provided by the implementing type
231
157
  */
232
- export declare const useCardHeader: (props: CardHeaderProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardHeaderProps | undefined) => CardHeaderState;
158
+ export declare const useCardHeader_unstable: (props: CardHeaderProps, ref: React_2.Ref<HTMLElement>) => CardHeaderState;
233
159
 
234
160
  /**
235
161
  * Apply styling to the CardHeader slots based on the state
236
162
  */
237
- export declare const useCardHeaderStyles: (state: CardHeaderState) => CardHeaderState;
163
+ export declare const useCardHeaderStyles_unstable: (state: CardHeaderState) => CardHeaderState;
238
164
 
239
165
  /**
240
166
  * Create the state required to render CardPreview.
241
167
  *
242
- * The returned state can be modified with hooks such as useCardPreviewStyles,
243
- * before being passed to renderCardPreview.
168
+ * The returned state can be modified with hooks such as useCardPreviewStyles_unstable,
169
+ * before being passed to renderCardPreview_unstable.
244
170
  *
245
171
  * @param props - props from this instance of CardPreview
246
172
  * @param ref - reference to root HTMLElement of CardPreview
247
- * @param defaultProps - (optional) default prop values provided by the implementing type
248
173
  */
249
- export declare const useCardPreview: (props: CardPreviewProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardPreviewProps | undefined) => CardPreviewState;
174
+ export declare const useCardPreview_unstable: (props: CardPreviewProps, ref: React_2.Ref<HTMLElement>) => CardPreviewState;
250
175
 
251
176
  /**
252
177
  * Apply styling to the CardPreview slots based on the state
253
178
  */
254
- export declare const useCardPreviewStyles: (state: CardPreviewState) => CardPreviewState;
179
+ export declare const useCardPreviewStyles_unstable: (state: CardPreviewState) => CardPreviewState;
255
180
 
256
181
  /**
257
182
  * Apply styling to the Card slots based on the state
258
183
  */
259
- export declare const useCardStyles: (state: CardState) => CardState;
184
+ export declare const useCardStyles_unstable: (state: CardState) => CardState;
260
185
 
261
186
  export { }
package/lib/Card.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Card.js","sourceRoot":"","sources":["../src/Card.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}
1
+ {"version":3,"file":"Card.js","sourceRoot":"../src/","sources":["Card.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC","sourcesContent":["export * from './components/Card/index';\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"CardFooter.js","sourceRoot":"","sources":["../src/CardFooter.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC"}
1
+ {"version":3,"file":"CardFooter.js","sourceRoot":"../src/","sources":["CardFooter.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC","sourcesContent":["export * from './components/CardFooter/index';\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"CardHeader.js","sourceRoot":"","sources":["../src/CardHeader.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC"}
1
+ {"version":3,"file":"CardHeader.js","sourceRoot":"../src/","sources":["CardHeader.ts"],"names":[],"mappings":"AAAA,cAAc,+BAA+B,CAAC","sourcesContent":["export * from './components/CardHeader/index';\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"CardPreview.js","sourceRoot":"","sources":["../src/CardPreview.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC"}
1
+ {"version":3,"file":"CardPreview.js","sourceRoot":"../src/","sources":["CardPreview.ts"],"names":[],"mappings":"AAAA,cAAc,gCAAgC,CAAC","sourcesContent":["export * from './components/CardPreview/index';\n"]}
@@ -1,6 +1,6 @@
1
- import * as React from 'react';
2
1
  import type { CardProps } from './Card.types';
2
+ import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
3
  /**
4
- * Component to provide scaffolding for hosting actions and content for a single topic within a card sized object.
4
+ * A card provides scaffolding for hosting actions and content for a single topic.
5
5
  */
6
- export declare const Card: React.ForwardRefExoticComponent<CardProps & React.RefAttributes<HTMLElement>>;
6
+ export declare const Card: ForwardRefComponent<CardProps>;
@@ -1,15 +1,15 @@
1
1
  import * as React from 'react';
2
- import { useCard } from './useCard';
3
- import { renderCard } from './renderCard';
4
- import { useCardStyles } from './useCardStyles';
2
+ import { useCard_unstable } from './useCard';
3
+ import { renderCard_unstable } from './renderCard';
4
+ import { useCardStyles_unstable } from './useCardStyles';
5
5
  /**
6
- * Component to provide scaffolding for hosting actions and content for a single topic within a card sized object.
6
+ * A card provides scaffolding for hosting actions and content for a single topic.
7
7
  */
8
8
 
9
- export var Card = /*#__PURE__*/React.forwardRef(function (props, ref) {
10
- var state = useCard(props, ref);
11
- useCardStyles(state);
12
- return renderCard(state);
9
+ export const Card = /*#__PURE__*/React.forwardRef((props, ref) => {
10
+ const state = useCard_unstable(props, ref);
11
+ useCardStyles_unstable(state);
12
+ return renderCard_unstable(state);
13
13
  });
14
14
  Card.displayName = 'Card';
15
15
  //# sourceMappingURL=Card.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/components/Card/Card.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,OAAT,QAAwB,WAAxB;AACA,SAAS,UAAT,QAA2B,cAA3B;AACA,SAAS,aAAT,QAA8B,iBAA9B;AAGA;;AAEG;;AACH,OAAO,IAAM,IAAI,gBAAG,KAAK,CAAC,UAAN,CAAyC,UAAC,KAAD,EAAQ,GAAR,EAAW;AACtE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAD,EAAQ,GAAR,CAArB;AAEA,EAAA,aAAa,CAAC,KAAD,CAAb;AACA,SAAO,UAAU,CAAC,KAAD,CAAjB;AACD,CALmB,CAAb;AAOP,IAAI,CAAC,WAAL,GAAmB,MAAnB","sourceRoot":""}
1
+ {"version":3,"sources":["components/Card/Card.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,gBAAT,QAAiC,WAAjC;AACA,SAAS,mBAAT,QAAoC,cAApC;AACA,SAAS,sBAAT,QAAuC,iBAAvC;AAIA;;AAEG;;AACH,OAAO,MAAM,IAAI,gBAAmC,KAAK,CAAC,UAAN,CAAiB,CAAC,KAAD,EAAQ,GAAR,KAAe;AAClF,QAAM,KAAK,GAAG,gBAAgB,CAAC,KAAD,EAAQ,GAAR,CAA9B;AAEA,EAAA,sBAAsB,CAAC,KAAD,CAAtB;AACA,SAAO,mBAAmB,CAAC,KAAD,CAA1B;AACD,CALmD,CAA7C;AAOP,IAAI,CAAC,WAAL,GAAmB,MAAnB","sourcesContent":["import * as React from 'react';\nimport { useCard_unstable } from './useCard';\nimport { renderCard_unstable } from './renderCard';\nimport { useCardStyles_unstable } from './useCardStyles';\nimport type { CardProps } from './Card.types';\nimport type { ForwardRefComponent } from '@fluentui/react-utilities';\n\n/**\n * A card provides scaffolding for hosting actions and content for a single topic.\n */\nexport const Card: ForwardRefComponent<CardProps> = React.forwardRef((props, ref) => {\n const state = useCard_unstable(props, ref);\n\n useCardStyles_unstable(state);\n return renderCard_unstable(state);\n});\n\nCard.displayName = 'Card';\n"],"sourceRoot":"../src/"}
@@ -1,24 +1,15 @@
1
- import * as React from 'react';
2
- import type { ComponentPropsCompat, ComponentStateCompat } from '@fluentui/react-utilities';
1
+ import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
2
+ export declare type CardSlots = {
3
+ root: Slot<'div'>;
4
+ };
5
+ export declare type CardCommons = {
6
+ appearance: 'filled' | 'filled-alternative' | 'outline' | 'subtle';
7
+ };
3
8
  /**
4
9
  * Card Props
5
10
  */
6
- export interface CardProps extends ComponentPropsCompat, React.HTMLAttributes<HTMLElement> {
7
- }
8
- /**
9
- * Names of the shorthand properties in CardProps
10
- */
11
- export declare type CardShorthandProps = never;
12
- /**
13
- * Names of CardProps that have a default value in useCard
14
- */
15
- export declare type CardDefaultedProps = never;
11
+ export declare type CardProps = ComponentProps<CardSlots> & Partial<CardCommons>;
16
12
  /**
17
13
  * State used in rendering Card
18
14
  */
19
- export interface CardState extends CardProps, ComponentStateCompat<CardProps, CardShorthandProps, CardDefaultedProps> {
20
- /**
21
- * Ref to the root element
22
- */
23
- ref: React.Ref<HTMLElement>;
24
- }
15
+ export declare type CardState = ComponentState<CardSlots> & CardCommons;
@@ -1 +1 @@
1
- {"version":3,"file":"Card.types.js","sourceRoot":"","sources":["../../../src/components/Card/Card.types.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"Card.types.js","sourceRoot":"../src/","sources":["components/Card/Card.types.ts"],"names":[],"mappings":"","sourcesContent":["import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';\n\nexport type CardSlots = {\n root: Slot<'div'>;\n};\n\nexport type CardCommons = {\n appearance: 'filled' | 'filled-alternative' | 'outline' | 'subtle';\n};\n\n/**\n * Card Props\n */\nexport type CardProps = ComponentProps<CardSlots> & Partial<CardCommons>;\n\n/**\n * State used in rendering Card\n */\nexport type CardState = ComponentState<CardSlots> & CardCommons;\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/components/Card/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"../src/","sources":["components/Card/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAC;AACvB,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC","sourcesContent":["export * from './Card';\nexport * from './Card.types';\nexport * from './renderCard';\nexport * from './useCard';\nexport * from './useCardStyles';\n"]}
@@ -2,4 +2,4 @@ import type { CardState } from './Card.types';
2
2
  /**
3
3
  * Render the final JSX of Card
4
4
  */
5
- export declare const renderCard: (state: CardState) => JSX.Element;
5
+ export declare const renderCard_unstable: (state: CardState) => JSX.Element;
@@ -1,15 +1,15 @@
1
- import { __assign } from "tslib";
2
1
  import * as React from 'react';
3
- import { getSlotsCompat } from '@fluentui/react-utilities';
2
+ import { getSlots } from '@fluentui/react-utilities';
4
3
  /**
5
4
  * Render the final JSX of Card
6
5
  */
7
6
 
8
- export var renderCard = function (state) {
9
- var _a = getSlotsCompat(state),
10
- slots = _a.slots,
11
- slotProps = _a.slotProps;
12
-
13
- return /*#__PURE__*/React.createElement(slots.root, __assign({}, slotProps.root), state.children);
7
+ export const renderCard_unstable = state => {
8
+ const {
9
+ slots,
10
+ slotProps
11
+ } = getSlots(state);
12
+ return /*#__PURE__*/React.createElement(slots.root, { ...slotProps.root
13
+ });
14
14
  };
15
15
  //# sourceMappingURL=renderCard.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/components/Card/renderCard.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,cAAT,QAA+B,2BAA/B;AAGA;;AAEG;;AACH,OAAO,IAAM,UAAU,GAAG,UAAC,KAAD,EAAiB;AACnC,MAAA,EAAA,GAAuB,cAAc,CAAC,KAAD,CAArC;AAAA,MAAE,KAAK,GAAA,EAAA,CAAA,KAAP;AAAA,MAAS,SAAS,GAAA,EAAA,CAAA,SAAlB;;AAEN,sBAAO,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,IAAP,EAAW,QAAA,CAAA,EAAA,EAAK,SAAS,CAAC,IAAf,CAAX,EAAiC,KAAK,CAAC,QAAvC,CAAP;AACD,CAJM","sourceRoot":""}
1
+ {"version":3,"sources":["components/Card/renderCard.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAZ,MAAuB,OAAvB;AACA,SAAS,QAAT,QAAyB,2BAAzB;AAGA;;AAEG;;AACH,OAAO,MAAM,mBAAmB,GAAI,KAAD,IAAqB;AACtD,QAAM;AAAE,IAAA,KAAF;AAAS,IAAA;AAAT,MAAuB,QAAQ,CAAY,KAAZ,CAArC;AAEA,sBAAO,KAAA,CAAA,aAAA,CAAC,KAAK,CAAC,IAAP,EAAW,EAAA,GAAK,SAAS,CAAC;AAAf,GAAX,CAAP;AACD,CAJM","sourcesContent":["import * as React from 'react';\nimport { getSlots } from '@fluentui/react-utilities';\nimport type { CardSlots, CardState } from './Card.types';\n\n/**\n * Render the final JSX of Card\n */\nexport const renderCard_unstable = (state: CardState) => {\n const { slots, slotProps } = getSlots<CardSlots>(state);\n\n return <slots.root {...slotProps.root} />;\n};\n"],"sourceRoot":"../src/"}
@@ -3,11 +3,10 @@ import type { CardProps, CardState } from './Card.types';
3
3
  /**
4
4
  * Create the state required to render Card.
5
5
  *
6
- * The returned state can be modified with hooks such as useCardStyles,
7
- * before being passed to renderCard.
6
+ * The returned state can be modified with hooks such as useCardStyles_unstable,
7
+ * before being passed to renderCard_unstable.
8
8
  *
9
9
  * @param props - props from this instance of Card
10
10
  * @param ref - reference to root HTMLElement of Card
11
- * @param defaultProps - (optional) default prop values provided by the implementing type
12
11
  */
13
- export declare const useCard: (props: CardProps, ref: React.Ref<HTMLElement>, defaultProps?: CardProps | undefined) => CardState;
12
+ export declare const useCard_unstable: (props: CardProps, ref: React.Ref<HTMLElement>) => CardState;
@@ -1,21 +1,33 @@
1
- import { makeMergeProps } from '@fluentui/react-utilities';
2
- var mergeProps = /*#__PURE__*/makeMergeProps();
1
+ import { getNativeElementProps } from '@fluentui/react-utilities';
2
+ import { useFocusableGroup } from '@fluentui/react-tabster';
3
3
  /**
4
4
  * Create the state required to render Card.
5
5
  *
6
- * The returned state can be modified with hooks such as useCardStyles,
7
- * before being passed to renderCard.
6
+ * The returned state can be modified with hooks such as useCardStyles_unstable,
7
+ * before being passed to renderCard_unstable.
8
8
  *
9
9
  * @param props - props from this instance of Card
10
10
  * @param ref - reference to root HTMLElement of Card
11
- * @param defaultProps - (optional) default prop values provided by the implementing type
12
11
  */
13
12
 
14
- export var useCard = function (props, ref, defaultProps) {
15
- var state = mergeProps({
16
- ref: ref,
17
- role: 'group'
18
- }, defaultProps, props);
19
- return state;
13
+ export const useCard_unstable = (props, ref) => {
14
+ const groupperAttrs = useFocusableGroup({
15
+ tabBehavior: 'limitedTrapFocus'
16
+ });
17
+ const {
18
+ appearance = 'filled'
19
+ } = props;
20
+ return {
21
+ appearance,
22
+ components: {
23
+ root: 'div'
24
+ },
25
+ root: getNativeElementProps(props.as || 'div', {
26
+ ref,
27
+ role: 'group',
28
+ ...groupperAttrs,
29
+ ...props
30
+ })
31
+ };
20
32
  };
21
33
  //# sourceMappingURL=useCard.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../../src/components/Card/useCard.ts"],"names":[],"mappings":"AACA,SAAS,cAAT,QAA+B,2BAA/B;AAGA,IAAM,UAAU,gBAAG,cAAc,EAAjC;AAEA;;;;;;;;;AASG;;AACH,OAAO,IAAM,OAAO,GAAG,UAAC,KAAD,EAAmB,GAAnB,EAAgD,YAAhD,EAAwE;AAC7F,MAAM,KAAK,GAAG,UAAU,CACtB;AACE,IAAA,GAAG,EAAA,GADL;AAEE,IAAA,IAAI,EAAE;AAFR,GADsB,EAKtB,YALsB,EAMtB,KANsB,CAAxB;AASA,SAAO,KAAP;AACD,CAXM","sourceRoot":""}
1
+ {"version":3,"sources":["components/Card/useCard.ts"],"names":[],"mappings":"AACA,SAAS,qBAAT,QAAsC,2BAAtC;AAEA,SAAS,iBAAT,QAAkC,yBAAlC;AAEA;;;;;;;;AAQG;;AACH,OAAO,MAAM,gBAAgB,GAAG,CAAC,KAAD,EAAmB,GAAnB,KAA6D;AAC3F,QAAM,aAAa,GAAG,iBAAiB,CAAC;AACtC,IAAA,WAAW,EAAE;AADyB,GAAD,CAAvC;AAIA,QAAM;AAAE,IAAA,UAAU,GAAG;AAAf,MAA4B,KAAlC;AACA,SAAO;AACL,IAAA,UADK;AAGL,IAAA,UAAU,EAAE;AAAE,MAAA,IAAI,EAAE;AAAR,KAHP;AAIL,IAAA,IAAI,EAAE,qBAAqB,CAAC,KAAK,CAAC,EAAN,IAAY,KAAb,EAAoB;AAC7C,MAAA,GAD6C;AAE7C,MAAA,IAAI,EAAE,OAFuC;AAG7C,SAAG,aAH0C;AAI7C,SAAG;AAJ0C,KAApB;AAJtB,GAAP;AAWD,CAjBM","sourcesContent":["import * as React from 'react';\nimport { getNativeElementProps } from '@fluentui/react-utilities';\nimport type { CardProps, CardState } from './Card.types';\nimport { useFocusableGroup } from '@fluentui/react-tabster';\n\n/**\n * Create the state required to render Card.\n *\n * The returned state can be modified with hooks such as useCardStyles_unstable,\n * before being passed to renderCard_unstable.\n *\n * @param props - props from this instance of Card\n * @param ref - reference to root HTMLElement of Card\n */\nexport const useCard_unstable = (props: CardProps, ref: React.Ref<HTMLElement>): CardState => {\n const groupperAttrs = useFocusableGroup({\n tabBehavior: 'limitedTrapFocus',\n });\n\n const { appearance = 'filled' } = props;\n return {\n appearance,\n\n components: { root: 'div' },\n root: getNativeElementProps(props.as || 'div', {\n ref,\n role: 'group',\n ...groupperAttrs,\n ...props,\n }),\n };\n};\n"],"sourceRoot":"../src/"}
@@ -1,5 +1,6 @@
1
1
  import type { CardState } from './Card.types';
2
+ export declare const cardClassName = "fui-Card";
2
3
  /**
3
4
  * Apply styling to the Card slots based on the state
4
5
  */
5
- export declare const useCardStyles: (state: CardState) => CardState;
6
+ export declare const useCardStyles_unstable: (state: CardState) => CardState;