@fluentui/react-card 9.0.0-beta.1 → 9.0.0-beta.12

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 (167) hide show
  1. package/CHANGELOG.json +640 -1
  2. package/CHANGELOG.md +158 -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 +72 -127
  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 +1 -1
  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 +8 -2
  42. package/lib/components/Card/useCardStyles.js +138 -25
  43. package/lib/components/Card/useCardStyles.js.map +1 -1
  44. package/lib/components/CardFooter/CardFooter.js +7 -7
  45. package/lib/components/CardFooter/CardFooter.js.map +1 -1
  46. package/lib/components/CardFooter/CardFooter.types.d.ts +8 -23
  47. package/lib/components/CardFooter/CardFooter.types.js.map +1 -1
  48. package/lib/components/CardFooter/index.js.map +1 -1
  49. package/lib/components/CardFooter/renderCardFooter.d.ts +1 -1
  50. package/lib/components/CardFooter/renderCardFooter.js +9 -9
  51. package/lib/components/CardFooter/renderCardFooter.js.map +1 -1
  52. package/lib/components/CardFooter/useCardFooter.d.ts +4 -9
  53. package/lib/components/CardFooter/useCardFooter.js +18 -17
  54. package/lib/components/CardFooter/useCardFooter.js.map +1 -1
  55. package/lib/components/CardFooter/useCardFooterStyles.d.ts +8 -2
  56. package/lib/components/CardFooter/useCardFooterStyles.js +18 -8
  57. package/lib/components/CardFooter/useCardFooterStyles.js.map +1 -1
  58. package/lib/components/CardHeader/CardHeader.js +7 -7
  59. package/lib/components/CardHeader/CardHeader.js.map +1 -1
  60. package/lib/components/CardHeader/CardHeader.types.d.ts +12 -39
  61. package/lib/components/CardHeader/CardHeader.types.js.map +1 -1
  62. package/lib/components/CardHeader/index.js.map +1 -1
  63. package/lib/components/CardHeader/renderCardHeader.d.ts +1 -1
  64. package/lib/components/CardHeader/renderCardHeader.js +13 -9
  65. package/lib/components/CardHeader/renderCardHeader.js.map +1 -1
  66. package/lib/components/CardHeader/useCardHeader.d.ts +4 -9
  67. package/lib/components/CardHeader/useCardHeader.js +35 -33
  68. package/lib/components/CardHeader/useCardHeader.js.map +1 -1
  69. package/lib/components/CardHeader/useCardHeaderStyles.d.ts +8 -2
  70. package/lib/components/CardHeader/useCardHeaderStyles.js +35 -9
  71. package/lib/components/CardHeader/useCardHeaderStyles.js.map +1 -1
  72. package/lib/components/CardPreview/CardPreview.js +7 -7
  73. package/lib/components/CardPreview/CardPreview.js.map +1 -1
  74. package/lib/components/CardPreview/CardPreview.types.d.ts +8 -23
  75. package/lib/components/CardPreview/CardPreview.types.js.map +1 -1
  76. package/lib/components/CardPreview/index.js.map +1 -1
  77. package/lib/components/CardPreview/renderCardPreview.d.ts +1 -1
  78. package/lib/components/CardPreview/renderCardPreview.js +9 -9
  79. package/lib/components/CardPreview/renderCardPreview.js.map +1 -1
  80. package/lib/components/CardPreview/useCardPreview.d.ts +4 -9
  81. package/lib/components/CardPreview/useCardPreview.js +18 -20
  82. package/lib/components/CardPreview/useCardPreview.js.map +1 -1
  83. package/lib/components/CardPreview/useCardPreviewStyles.d.ts +8 -2
  84. package/lib/components/CardPreview/useCardPreviewStyles.js +16 -11
  85. package/lib/components/CardPreview/useCardPreviewStyles.js.map +1 -1
  86. package/lib/index.d.ts +8 -4
  87. package/lib/index.js +5 -4
  88. package/lib/index.js.map +1 -1
  89. package/lib-commonjs/Card.js +1 -1
  90. package/lib-commonjs/Card.js.map +1 -1
  91. package/lib-commonjs/CardFooter.js +1 -1
  92. package/lib-commonjs/CardFooter.js.map +1 -1
  93. package/lib-commonjs/CardHeader.js +1 -1
  94. package/lib-commonjs/CardHeader.js.map +1 -1
  95. package/lib-commonjs/CardPreview.js +1 -1
  96. package/lib-commonjs/CardPreview.js.map +1 -1
  97. package/lib-commonjs/components/Card/Card.d.ts +1 -1
  98. package/lib-commonjs/components/Card/Card.js +9 -9
  99. package/lib-commonjs/components/Card/Card.js.map +1 -1
  100. package/lib-commonjs/components/Card/Card.types.d.ts +9 -18
  101. package/lib-commonjs/components/Card/Card.types.js.map +1 -1
  102. package/lib-commonjs/components/Card/index.js +1 -1
  103. package/lib-commonjs/components/Card/index.js.map +1 -1
  104. package/lib-commonjs/components/Card/renderCard.d.ts +1 -1
  105. package/lib-commonjs/components/Card/renderCard.js +11 -12
  106. package/lib-commonjs/components/Card/renderCard.js.map +1 -1
  107. package/lib-commonjs/components/Card/useCard.d.ts +3 -4
  108. package/lib-commonjs/components/Card/useCard.js +26 -13
  109. package/lib-commonjs/components/Card/useCard.js.map +1 -1
  110. package/lib-commonjs/components/Card/useCardStyles.d.ts +8 -2
  111. package/lib-commonjs/components/Card/useCardStyles.js +143 -28
  112. package/lib-commonjs/components/Card/useCardStyles.js.map +1 -1
  113. package/lib-commonjs/components/CardFooter/CardFooter.js +8 -8
  114. package/lib-commonjs/components/CardFooter/CardFooter.js.map +1 -1
  115. package/lib-commonjs/components/CardFooter/CardFooter.types.d.ts +8 -23
  116. package/lib-commonjs/components/CardFooter/CardFooter.types.js.map +1 -1
  117. package/lib-commonjs/components/CardFooter/index.js +1 -1
  118. package/lib-commonjs/components/CardFooter/index.js.map +1 -1
  119. package/lib-commonjs/components/CardFooter/renderCardFooter.d.ts +1 -1
  120. package/lib-commonjs/components/CardFooter/renderCardFooter.js +12 -14
  121. package/lib-commonjs/components/CardFooter/renderCardFooter.js.map +1 -1
  122. package/lib-commonjs/components/CardFooter/useCardFooter.d.ts +4 -9
  123. package/lib-commonjs/components/CardFooter/useCardFooter.js +21 -20
  124. package/lib-commonjs/components/CardFooter/useCardFooter.js.map +1 -1
  125. package/lib-commonjs/components/CardFooter/useCardFooterStyles.d.ts +8 -2
  126. package/lib-commonjs/components/CardFooter/useCardFooterStyles.js +21 -11
  127. package/lib-commonjs/components/CardFooter/useCardFooterStyles.js.map +1 -1
  128. package/lib-commonjs/components/CardHeader/CardHeader.js +8 -8
  129. package/lib-commonjs/components/CardHeader/CardHeader.js.map +1 -1
  130. package/lib-commonjs/components/CardHeader/CardHeader.types.d.ts +12 -39
  131. package/lib-commonjs/components/CardHeader/CardHeader.types.js.map +1 -1
  132. package/lib-commonjs/components/CardHeader/index.js +1 -1
  133. package/lib-commonjs/components/CardHeader/index.js.map +1 -1
  134. package/lib-commonjs/components/CardHeader/renderCardHeader.d.ts +1 -1
  135. package/lib-commonjs/components/CardHeader/renderCardHeader.js +16 -14
  136. package/lib-commonjs/components/CardHeader/renderCardHeader.js.map +1 -1
  137. package/lib-commonjs/components/CardHeader/useCardHeader.d.ts +4 -9
  138. package/lib-commonjs/components/CardHeader/useCardHeader.js +38 -37
  139. package/lib-commonjs/components/CardHeader/useCardHeader.js.map +1 -1
  140. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.d.ts +8 -2
  141. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.js +38 -12
  142. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.js.map +1 -1
  143. package/lib-commonjs/components/CardPreview/CardPreview.js +8 -8
  144. package/lib-commonjs/components/CardPreview/CardPreview.js.map +1 -1
  145. package/lib-commonjs/components/CardPreview/CardPreview.types.d.ts +8 -23
  146. package/lib-commonjs/components/CardPreview/CardPreview.types.js.map +1 -1
  147. package/lib-commonjs/components/CardPreview/index.js +1 -1
  148. package/lib-commonjs/components/CardPreview/index.js.map +1 -1
  149. package/lib-commonjs/components/CardPreview/renderCardPreview.d.ts +1 -1
  150. package/lib-commonjs/components/CardPreview/renderCardPreview.js +12 -14
  151. package/lib-commonjs/components/CardPreview/renderCardPreview.js.map +1 -1
  152. package/lib-commonjs/components/CardPreview/useCardPreview.d.ts +4 -9
  153. package/lib-commonjs/components/CardPreview/useCardPreview.js +21 -23
  154. package/lib-commonjs/components/CardPreview/useCardPreview.js.map +1 -1
  155. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.d.ts +8 -2
  156. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.js +19 -14
  157. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.js.map +1 -1
  158. package/lib-commonjs/index.d.ts +8 -4
  159. package/lib-commonjs/index.js +153 -5
  160. package/lib-commonjs/index.js.map +1 -1
  161. package/package.json +19 -22
  162. package/lib/common/isConformant.d.ts +0 -4
  163. package/lib/common/isConformant.js +0 -11
  164. package/lib/common/isConformant.js.map +0 -1
  165. package/lib-commonjs/common/isConformant.d.ts +0 -4
  166. package/lib-commonjs/common/isConformant.js +0 -22
  167. package/lib-commonjs/common/isConformant.js.map +0 -1
@@ -1,18 +1,25 @@
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
3
  import type { ForwardRefComponent } from '@fluentui/react-utilities';
4
4
  import * as React_2 from 'react';
5
- import type { ShorthandPropsCompat } from '@fluentui/react-utilities';
5
+ import type { Slot } from '@fluentui/react-utilities';
6
+ import type { SlotClassNames } from '@fluentui/react-utilities';
6
7
 
7
8
  /**
8
- * Component to provide scaffolding for hosting actions and content for a single topic within a card sized object.
9
+ * A card provides scaffolding for hosting actions and content for a single topic.
9
10
  */
10
11
  export declare const Card: ForwardRefComponent<CardProps>;
11
12
 
12
13
  /**
13
- * Names of CardProps that have a default value in useCard
14
+ * @deprecated Use `cardClassNames.root` instead.
14
15
  */
15
- export declare type CardDefaultedProps = never;
16
+ export declare const cardClassName = "fui-Card";
17
+
18
+ export declare const cardClassNames: SlotClassNames<CardSlots>;
19
+
20
+ export declare type CardCommons = {
21
+ appearance: 'filled' | 'filled-alternative' | 'outline' | 'subtle';
22
+ };
16
23
 
17
24
  /**
18
25
  * Component to render Button actions in a Card component.
@@ -20,39 +27,26 @@ export declare type CardDefaultedProps = never;
20
27
  export declare const CardFooter: ForwardRefComponent<CardFooterProps>;
21
28
 
22
29
  /**
23
- * Names of CardFooterProps that have a default value in useCardFooter
30
+ * @deprecated Use `cardFooterClassNames.root` instead.
24
31
  */
25
- export declare type CardFooterDefaultedProps = never;
32
+ export declare const cardFooterClassName = "fui-CardFooter";
26
33
 
27
- /**
28
- * CardFooter Props
29
- */
30
- export declare interface CardFooterProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
31
- /**
32
- * Actions slot
33
- */
34
- action?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
35
- }
34
+ export declare const cardFooterClassNames: SlotClassNames<CardFooterSlots>;
36
35
 
37
36
  /**
38
- * Names of the shorthand properties in CardFooterProps
37
+ * CardFooter props
39
38
  */
40
- export declare type CardFooterShorthandProps = 'action';
39
+ export declare type CardFooterProps = ComponentProps<CardFooterSlots>;
41
40
 
42
- /**
43
- * Array of all shorthand properties listed in CardFooterShorthandProps
44
- */
45
- export declare const cardFooterShorthandProps: CardFooterShorthandProps[];
41
+ export declare type CardFooterSlots = {
42
+ root: Slot<'div'>;
43
+ action?: Slot<'div'>;
44
+ };
46
45
 
47
46
  /**
48
47
  * State used in rendering CardFooter
49
48
  */
50
- export declare interface CardFooterState extends ComponentStateCompat<CardFooterProps, CardFooterShorthandProps, CardFooterDefaultedProps> {
51
- /**
52
- * Ref to the root element
53
- */
54
- ref: React_2.Ref<HTMLElement>;
55
- }
49
+ export declare type CardFooterState = ComponentState<CardFooterSlots>;
56
50
 
57
51
  /**
58
52
  * Component to render an image, text and an action in a Card component.
@@ -60,55 +54,30 @@ export declare interface CardFooterState extends ComponentStateCompat<CardFooter
60
54
  export declare const CardHeader: ForwardRefComponent<CardHeaderProps>;
61
55
 
62
56
  /**
63
- * Names of CardHeaderProps that have a default value in useCardHeader
57
+ * @deprecated Use `cardHeaderClassNames.root` instead.
64
58
  */
65
- export declare type CardHeaderDefaultedProps = never;
59
+ export declare const cardHeaderClassName = "fui-CardHeader";
66
60
 
67
- /**
68
- * CardHeader Props
69
- */
70
- export declare interface CardHeaderProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
71
- /**
72
- * Image slot
73
- */
74
- image: ShorthandPropsCompat<React_2.ImgHTMLAttributes<HTMLImageElement>>;
75
- /**
76
- * Content slot, wrapper of the header and description slots
77
- */
78
- content?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
79
- /**
80
- * Header title slot
81
- */
82
- header: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
83
- /**
84
- * Description slot
85
- */
86
- description: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
87
- /**
88
- * Actions slot
89
- */
90
- action?: ShorthandPropsCompat<React_2.HTMLAttributes<HTMLElement>>;
91
- }
61
+ export declare const cardHeaderClassNames: SlotClassNames<CardHeaderSlots>;
92
62
 
93
63
  /**
94
- * Names of the shorthand properties in CardHeaderProps
64
+ * CardHeader props
95
65
  */
96
- export declare type CardHeaderShorthandProps = 'image' | 'content' | 'header' | 'description' | 'action';
66
+ export declare type CardHeaderProps = ComponentProps<Partial<CardHeaderSlots>>;
97
67
 
98
- /**
99
- * Array of all shorthand properties listed in CardHeaderShorthandProps
100
- */
101
- export declare const cardHeaderShorthandPropsCompat: CardHeaderShorthandProps[];
68
+ export declare type CardHeaderSlots = {
69
+ root: Slot<'div'>;
70
+ image: Slot<'div'>;
71
+ content?: Slot<'div'>;
72
+ header: Slot<'span'>;
73
+ description: Slot<'span'>;
74
+ action?: Slot<'div'>;
75
+ };
102
76
 
103
77
  /**
104
78
  * State used in rendering CardHeader
105
79
  */
106
- export declare interface CardHeaderState extends ComponentStateCompat<CardHeaderProps, CardHeaderShorthandProps> {
107
- /**
108
- * Ref to the root element
109
- */
110
- ref: React_2.Ref<HTMLElement>;
111
- }
80
+ export declare type CardHeaderState = ComponentState<CardHeaderSlots>;
112
81
 
113
82
  /**
114
83
  * Component to render image previews of documents or articles in a Card component.
@@ -116,147 +85,123 @@ export declare interface CardHeaderState extends ComponentStateCompat<CardHeader
116
85
  export declare const CardPreview: ForwardRefComponent<CardPreviewProps>;
117
86
 
118
87
  /**
119
- * Names of CardPreviewProps that have a default value in useCardPreview
88
+ * @deprecated Use `cardPreviewClassNames.root` instead.
120
89
  */
121
- export declare type CardPreviewDefaultedProps = never;
90
+ export declare const cardPreviewClassName = "fui-CardPreview";
122
91
 
123
- /**
124
- * CardPreview Props
125
- */
126
- export declare interface CardPreviewProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
127
- /**
128
- * Image slot
129
- */
130
- logo?: ShorthandPropsCompat<React_2.ImgHTMLAttributes<HTMLImageElement>>;
131
- }
92
+ export declare const cardPreviewClassNames: SlotClassNames<CardPreviewSlots>;
132
93
 
133
94
  /**
134
- * Names of the shorthand properties in CardPreviewProps
95
+ * CardPreview props
135
96
  */
136
- export declare type CardPreviewShorthandProps = 'logo';
97
+ export declare type CardPreviewProps = ComponentProps<CardPreviewSlots>;
137
98
 
138
- /**
139
- * Array of all shorthand properties listed in CardPreviewShorthandProps
140
- */
141
- export declare const cardPreviewShorthandPropsCompat: CardPreviewShorthandProps[];
99
+ export declare type CardPreviewSlots = {
100
+ root: Slot<'div'>;
101
+ logo?: Slot<'div'>;
102
+ };
142
103
 
143
104
  /**
144
105
  * State used in rendering CardPreview
145
106
  */
146
- export declare interface CardPreviewState extends ComponentStateCompat<CardPreviewProps, CardPreviewShorthandProps, CardPreviewDefaultedProps> {
147
- /**
148
- * Ref to the root element
149
- */
150
- ref: React_2.Ref<HTMLElement>;
151
- }
107
+ export declare type CardPreviewState = ComponentState<CardPreviewSlots>;
152
108
 
153
109
  /**
154
110
  * Card Props
155
111
  */
156
- export declare interface CardProps extends ComponentPropsCompat, React_2.HTMLAttributes<HTMLElement> {
157
- }
112
+ export declare type CardProps = ComponentProps<CardSlots> & Partial<CardCommons>;
158
113
 
159
- /**
160
- * Names of the shorthand properties in CardProps
161
- */
162
- export declare type CardShorthandProps = never;
114
+ export declare type CardSlots = {
115
+ root: Slot<'div'>;
116
+ };
163
117
 
164
118
  /**
165
119
  * State used in rendering Card
166
120
  */
167
- export declare interface CardState extends CardProps, ComponentStateCompat<CardProps, CardShorthandProps, CardDefaultedProps> {
168
- /**
169
- * Ref to the root element
170
- */
171
- ref: React_2.Ref<HTMLElement>;
172
- }
121
+ export declare type CardState = ComponentState<CardSlots> & CardCommons;
173
122
 
174
123
  /**
175
124
  * Render the final JSX of Card
176
125
  */
177
- export declare const renderCard: (state: CardState) => JSX.Element;
126
+ export declare const renderCard_unstable: (state: CardState) => JSX.Element;
178
127
 
179
128
  /**
180
129
  * Render the final JSX of CardFooter
181
130
  */
182
- export declare const renderCardFooter: (state: CardFooterState) => JSX.Element;
131
+ export declare const renderCardFooter_unstable: (state: CardFooterState) => JSX.Element;
183
132
 
184
133
  /**
185
134
  * Render the final JSX of CardHeader
186
135
  */
187
- export declare const renderCardHeader: (state: CardHeaderState) => JSX.Element;
136
+ export declare const renderCardHeader_unstable: (state: CardHeaderState) => JSX.Element;
188
137
 
189
138
  /**
190
139
  * Render the final JSX of CardPreview
191
140
  */
192
- export declare const renderCardPreview: (state: CardPreviewState) => JSX.Element;
141
+ export declare const renderCardPreview_unstable: (state: CardPreviewState) => JSX.Element;
193
142
 
194
143
  /**
195
144
  * Create the state required to render Card.
196
145
  *
197
- * The returned state can be modified with hooks such as useCardStyles,
198
- * before being passed to renderCard.
146
+ * The returned state can be modified with hooks such as useCardStyles_unstable,
147
+ * before being passed to renderCard_unstable.
199
148
  *
200
149
  * @param props - props from this instance of Card
201
150
  * @param ref - reference to root HTMLElement of Card
202
- * @param defaultProps - (optional) default prop values provided by the implementing type
203
151
  */
204
- export declare const useCard: (props: CardProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardProps | undefined) => CardState;
152
+ export declare const useCard_unstable: (props: CardProps, ref: React_2.Ref<HTMLElement>) => CardState;
205
153
 
206
154
  /**
207
155
  * Create the state required to render CardFooter.
208
156
  *
209
- * The returned state can be modified with hooks such as useCardFooterStyles,
210
- * before being passed to renderCardFooter.
157
+ * The returned state can be modified with hooks such as useCardFooterStyles_unstable,
158
+ * before being passed to renderCardFooter_unstable.
211
159
  *
212
160
  * @param props - props from this instance of CardFooter
213
161
  * @param ref - reference to root HTMLElement of CardFooter
214
- * @param defaultProps - (optional) default prop values provided by the implementing type
215
162
  */
216
- export declare const useCardFooter: (props: CardFooterProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardFooterProps | undefined) => CardFooterState;
163
+ export declare const useCardFooter_unstable: (props: CardFooterProps, ref: React_2.Ref<HTMLElement>) => CardFooterState;
217
164
 
218
165
  /**
219
166
  * Apply styling to the CardFooter slots based on the state
220
167
  */
221
- export declare const useCardFooterStyles: (state: CardFooterState) => CardFooterState;
168
+ export declare const useCardFooterStyles_unstable: (state: CardFooterState) => CardFooterState;
222
169
 
223
170
  /**
224
171
  * Create the state required to render CardHeader.
225
172
  *
226
- * The returned state can be modified with hooks such as useCardHeaderStyles,
227
- * before being passed to renderCardHeader.
173
+ * The returned state can be modified with hooks such as useCardHeaderStyles_unstable,
174
+ * before being passed to renderCardHeader_unstable.
228
175
  *
229
176
  * @param props - props from this instance of CardHeader
230
177
  * @param ref - reference to root HTMLElement of CardHeader
231
- * @param defaultProps - (optional) default prop values provided by the implementing type
232
178
  */
233
- export declare const useCardHeader: (props: CardHeaderProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardHeaderProps | undefined) => CardHeaderState;
179
+ export declare const useCardHeader_unstable: (props: CardHeaderProps, ref: React_2.Ref<HTMLElement>) => CardHeaderState;
234
180
 
235
181
  /**
236
182
  * Apply styling to the CardHeader slots based on the state
237
183
  */
238
- export declare const useCardHeaderStyles: (state: CardHeaderState) => CardHeaderState;
184
+ export declare const useCardHeaderStyles_unstable: (state: CardHeaderState) => CardHeaderState;
239
185
 
240
186
  /**
241
187
  * Create the state required to render CardPreview.
242
188
  *
243
- * The returned state can be modified with hooks such as useCardPreviewStyles,
244
- * before being passed to renderCardPreview.
189
+ * The returned state can be modified with hooks such as useCardPreviewStyles_unstable,
190
+ * before being passed to renderCardPreview_unstable.
245
191
  *
246
192
  * @param props - props from this instance of CardPreview
247
193
  * @param ref - reference to root HTMLElement of CardPreview
248
- * @param defaultProps - (optional) default prop values provided by the implementing type
249
194
  */
250
- export declare const useCardPreview: (props: CardPreviewProps, ref: React_2.Ref<HTMLElement>, defaultProps?: CardPreviewProps | undefined) => CardPreviewState;
195
+ export declare const useCardPreview_unstable: (props: CardPreviewProps, ref: React_2.Ref<HTMLElement>) => CardPreviewState;
251
196
 
252
197
  /**
253
198
  * Apply styling to the CardPreview slots based on the state
254
199
  */
255
- export declare const useCardPreviewStyles: (state: CardPreviewState) => CardPreviewState;
200
+ export declare const useCardPreviewStyles_unstable: (state: CardPreviewState) => CardPreviewState;
256
201
 
257
202
  /**
258
203
  * Apply styling to the Card slots based on the state
259
204
  */
260
- export declare const useCardStyles: (state: CardState) => CardState;
205
+ export declare const useCardStyles_unstable: (state: CardState) => CardState;
261
206
 
262
207
  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
1
  import type { CardProps } from './Card.types';
2
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
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;AAIA;;AAEG;;AACH,OAAO,IAAM,IAAI,gBAAmC,KAAK,CAAC,UAAN,CAAiB,UAAC,KAAD,EAAQ,GAAR,EAAW;AAC9E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAD,EAAQ,GAAR,CAArB;AAEA,EAAA,aAAa,CAAC,KAAD,CAAb;AACA,SAAO,UAAU,CAAC,KAAD,CAAjB;AACD,CALmD,CAA7C;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,11 @@
1
- import type { CardState } from './Card.types';
1
+ import type { CardSlots, CardState } from './Card.types';
2
+ import type { SlotClassNames } from '@fluentui/react-utilities';
3
+ /**
4
+ * @deprecated Use `cardClassNames.root` instead.
5
+ */
6
+ export declare const cardClassName = "fui-Card";
7
+ export declare const cardClassNames: SlotClassNames<CardSlots>;
2
8
  /**
3
9
  * Apply styling to the Card slots based on the state
4
10
  */
5
- export declare const useCardStyles: (state: CardState) => CardState;
11
+ export declare const useCardStyles_unstable: (state: CardState) => CardState;