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

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 (75) hide show
  1. package/CHANGELOG.json +180 -1
  2. package/CHANGELOG.md +88 -40
  3. package/Spec.md +20 -16
  4. package/dist/{react-card.d.ts → index.d.ts} +25 -6
  5. package/{lib → dist}/tsdoc-metadata.json +0 -0
  6. package/lib/components/Card/Card.types.js.map +1 -1
  7. package/lib/components/Card/useCard.js +16 -5
  8. package/lib/components/Card/useCard.js.map +1 -1
  9. package/lib/components/Card/useCardStyles.js +80 -74
  10. package/lib/components/Card/useCardStyles.js.map +1 -1
  11. package/lib/index.js.map +1 -1
  12. package/lib-commonjs/components/Card/useCard.js +16 -5
  13. package/lib-commonjs/components/Card/useCard.js.map +1 -1
  14. package/lib-commonjs/components/Card/useCardStyles.js +80 -74
  15. package/lib-commonjs/components/Card/useCardStyles.js.map +1 -1
  16. package/lib-commonjs/index.js.map +1 -1
  17. package/package.json +12 -11
  18. package/lib/Card.d.ts +0 -1
  19. package/lib/CardFooter.d.ts +0 -1
  20. package/lib/CardHeader.d.ts +0 -1
  21. package/lib/CardPreview.d.ts +0 -1
  22. package/lib/components/Card/Card.d.ts +0 -6
  23. package/lib/components/Card/Card.types.d.ts +0 -15
  24. package/lib/components/Card/index.d.ts +0 -5
  25. package/lib/components/Card/renderCard.d.ts +0 -5
  26. package/lib/components/Card/useCard.d.ts +0 -12
  27. package/lib/components/Card/useCardStyles.d.ts +0 -11
  28. package/lib/components/CardFooter/CardFooter.d.ts +0 -6
  29. package/lib/components/CardFooter/CardFooter.types.d.ts +0 -13
  30. package/lib/components/CardFooter/index.d.ts +0 -5
  31. package/lib/components/CardFooter/renderCardFooter.d.ts +0 -5
  32. package/lib/components/CardFooter/useCardFooter.d.ts +0 -12
  33. package/lib/components/CardFooter/useCardFooterStyles.d.ts +0 -11
  34. package/lib/components/CardHeader/CardHeader.d.ts +0 -6
  35. package/lib/components/CardHeader/CardHeader.types.d.ts +0 -17
  36. package/lib/components/CardHeader/index.d.ts +0 -5
  37. package/lib/components/CardHeader/renderCardHeader.d.ts +0 -5
  38. package/lib/components/CardHeader/useCardHeader.d.ts +0 -12
  39. package/lib/components/CardHeader/useCardHeaderStyles.d.ts +0 -11
  40. package/lib/components/CardPreview/CardPreview.d.ts +0 -6
  41. package/lib/components/CardPreview/CardPreview.types.d.ts +0 -13
  42. package/lib/components/CardPreview/index.d.ts +0 -5
  43. package/lib/components/CardPreview/renderCardPreview.d.ts +0 -5
  44. package/lib/components/CardPreview/useCardPreview.d.ts +0 -12
  45. package/lib/components/CardPreview/useCardPreviewStyles.d.ts +0 -11
  46. package/lib/index.d.ts +0 -8
  47. package/lib-commonjs/Card.d.ts +0 -1
  48. package/lib-commonjs/CardFooter.d.ts +0 -1
  49. package/lib-commonjs/CardHeader.d.ts +0 -1
  50. package/lib-commonjs/CardPreview.d.ts +0 -1
  51. package/lib-commonjs/components/Card/Card.d.ts +0 -6
  52. package/lib-commonjs/components/Card/Card.types.d.ts +0 -15
  53. package/lib-commonjs/components/Card/index.d.ts +0 -5
  54. package/lib-commonjs/components/Card/renderCard.d.ts +0 -5
  55. package/lib-commonjs/components/Card/useCard.d.ts +0 -12
  56. package/lib-commonjs/components/Card/useCardStyles.d.ts +0 -11
  57. package/lib-commonjs/components/CardFooter/CardFooter.d.ts +0 -6
  58. package/lib-commonjs/components/CardFooter/CardFooter.types.d.ts +0 -13
  59. package/lib-commonjs/components/CardFooter/index.d.ts +0 -5
  60. package/lib-commonjs/components/CardFooter/renderCardFooter.d.ts +0 -5
  61. package/lib-commonjs/components/CardFooter/useCardFooter.d.ts +0 -12
  62. package/lib-commonjs/components/CardFooter/useCardFooterStyles.d.ts +0 -11
  63. package/lib-commonjs/components/CardHeader/CardHeader.d.ts +0 -6
  64. package/lib-commonjs/components/CardHeader/CardHeader.types.d.ts +0 -17
  65. package/lib-commonjs/components/CardHeader/index.d.ts +0 -5
  66. package/lib-commonjs/components/CardHeader/renderCardHeader.d.ts +0 -5
  67. package/lib-commonjs/components/CardHeader/useCardHeader.d.ts +0 -12
  68. package/lib-commonjs/components/CardHeader/useCardHeaderStyles.d.ts +0 -11
  69. package/lib-commonjs/components/CardPreview/CardPreview.d.ts +0 -6
  70. package/lib-commonjs/components/CardPreview/CardPreview.types.d.ts +0 -13
  71. package/lib-commonjs/components/CardPreview/index.d.ts +0 -5
  72. package/lib-commonjs/components/CardPreview/renderCardPreview.d.ts +0 -5
  73. package/lib-commonjs/components/CardPreview/useCardPreview.d.ts +0 -12
  74. package/lib-commonjs/components/CardPreview/useCardPreviewStyles.d.ts +0 -11
  75. package/lib-commonjs/index.d.ts +0 -8
@@ -1,11 +0,0 @@
1
- import type { SlotClassNames } from '@fluentui/react-utilities';
2
- import type { CardPreviewSlots, CardPreviewState } from './CardPreview.types';
3
- /**
4
- * @deprecated Use `cardPreviewClassNames.root` instead.
5
- */
6
- export declare const cardPreviewClassName = "fui-CardPreview";
7
- export declare const cardPreviewClassNames: SlotClassNames<CardPreviewSlots>;
8
- /**
9
- * Apply styling to the CardPreview slots based on the state
10
- */
11
- export declare const useCardPreviewStyles_unstable: (state: CardPreviewState) => CardPreviewState;
package/lib/index.d.ts DELETED
@@ -1,8 +0,0 @@
1
- export { Card, cardClassName, cardClassNames, renderCard_unstable, useCardStyles_unstable, useCard_unstable, } from './Card';
2
- export type { CardCommons, CardProps, CardSlots, CardState } from './Card';
3
- export { CardFooter, cardFooterClassName, cardFooterClassNames, renderCardFooter_unstable, useCardFooterStyles_unstable, useCardFooter_unstable, } from './CardFooter';
4
- export type { CardFooterProps, CardFooterSlots, CardFooterState } from './CardFooter';
5
- export { CardHeader, cardHeaderClassName, cardHeaderClassNames, renderCardHeader_unstable, useCardHeaderStyles_unstable, useCardHeader_unstable, } from './CardHeader';
6
- export type { CardHeaderProps, CardHeaderSlots, CardHeaderState } from './CardHeader';
7
- export { CardPreview, cardPreviewClassName, cardPreviewClassNames, renderCardPreview_unstable, useCardPreviewStyles_unstable, useCardPreview_unstable, } from './CardPreview';
8
- export type { CardPreviewProps, CardPreviewSlots, CardPreviewState } from './CardPreview';
@@ -1 +0,0 @@
1
- export * from './components/Card/index';
@@ -1 +0,0 @@
1
- export * from './components/CardFooter/index';
@@ -1 +0,0 @@
1
- export * from './components/CardHeader/index';
@@ -1 +0,0 @@
1
- export * from './components/CardPreview/index';
@@ -1,6 +0,0 @@
1
- import type { CardProps } from './Card.types';
2
- import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
- /**
4
- * A card provides scaffolding for hosting actions and content for a single topic.
5
- */
6
- export declare const Card: ForwardRefComponent<CardProps>;
@@ -1,15 +0,0 @@
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
- };
8
- /**
9
- * Card Props
10
- */
11
- export declare type CardProps = ComponentProps<CardSlots> & Partial<CardCommons>;
12
- /**
13
- * State used in rendering Card
14
- */
15
- export declare type CardState = ComponentState<CardSlots> & CardCommons;
@@ -1,5 +0,0 @@
1
- export * from './Card';
2
- export * from './Card.types';
3
- export * from './renderCard';
4
- export * from './useCard';
5
- export * from './useCardStyles';
@@ -1,5 +0,0 @@
1
- import type { CardState } from './Card.types';
2
- /**
3
- * Render the final JSX of Card
4
- */
5
- export declare const renderCard_unstable: (state: CardState) => JSX.Element;
@@ -1,12 +0,0 @@
1
- import * as React from 'react';
2
- import type { CardProps, CardState } from './Card.types';
3
- /**
4
- * Create the state required to render Card.
5
- *
6
- * The returned state can be modified with hooks such as useCardStyles_unstable,
7
- * before being passed to renderCard_unstable.
8
- *
9
- * @param props - props from this instance of Card
10
- * @param ref - reference to root HTMLElement of Card
11
- */
12
- export declare const useCard_unstable: (props: CardProps, ref: React.Ref<HTMLElement>) => CardState;
@@ -1,11 +0,0 @@
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>;
8
- /**
9
- * Apply styling to the Card slots based on the state
10
- */
11
- export declare const useCardStyles_unstable: (state: CardState) => CardState;
@@ -1,6 +0,0 @@
1
- import type { CardFooterProps } from './CardFooter.types';
2
- import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
- /**
4
- * Component to render Button actions in a Card component.
5
- */
6
- export declare const CardFooter: ForwardRefComponent<CardFooterProps>;
@@ -1,13 +0,0 @@
1
- import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
2
- export declare type CardFooterSlots = {
3
- root: Slot<'div'>;
4
- action?: Slot<'div'>;
5
- };
6
- /**
7
- * CardFooter props
8
- */
9
- export declare type CardFooterProps = ComponentProps<CardFooterSlots>;
10
- /**
11
- * State used in rendering CardFooter
12
- */
13
- export declare type CardFooterState = ComponentState<CardFooterSlots>;
@@ -1,5 +0,0 @@
1
- export * from './CardFooter';
2
- export * from './CardFooter.types';
3
- export * from './renderCardFooter';
4
- export * from './useCardFooter';
5
- export * from './useCardFooterStyles';
@@ -1,5 +0,0 @@
1
- import type { CardFooterState } from './CardFooter.types';
2
- /**
3
- * Render the final JSX of CardFooter
4
- */
5
- export declare const renderCardFooter_unstable: (state: CardFooterState) => JSX.Element;
@@ -1,12 +0,0 @@
1
- import * as React from 'react';
2
- import type { CardFooterProps, CardFooterState } from './CardFooter.types';
3
- /**
4
- * Create the state required to render CardFooter.
5
- *
6
- * The returned state can be modified with hooks such as useCardFooterStyles_unstable,
7
- * before being passed to renderCardFooter_unstable.
8
- *
9
- * @param props - props from this instance of CardFooter
10
- * @param ref - reference to root HTMLElement of CardFooter
11
- */
12
- export declare const useCardFooter_unstable: (props: CardFooterProps, ref: React.Ref<HTMLElement>) => CardFooterState;
@@ -1,11 +0,0 @@
1
- import type { SlotClassNames } from '@fluentui/react-utilities';
2
- import type { CardFooterSlots, CardFooterState } from './CardFooter.types';
3
- /**
4
- * @deprecated Use `cardFooterClassNames.root` instead.
5
- */
6
- export declare const cardFooterClassName = "fui-CardFooter";
7
- export declare const cardFooterClassNames: SlotClassNames<CardFooterSlots>;
8
- /**
9
- * Apply styling to the CardFooter slots based on the state
10
- */
11
- export declare const useCardFooterStyles_unstable: (state: CardFooterState) => CardFooterState;
@@ -1,6 +0,0 @@
1
- import type { CardHeaderProps } from './CardHeader.types';
2
- import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
- /**
4
- * Component to render an image, text and an action in a Card component.
5
- */
6
- export declare const CardHeader: ForwardRefComponent<CardHeaderProps>;
@@ -1,17 +0,0 @@
1
- import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
2
- export declare type CardHeaderSlots = {
3
- root: Slot<'div'>;
4
- image: Slot<'div'>;
5
- content?: Slot<'div'>;
6
- header: Slot<'span'>;
7
- description: Slot<'span'>;
8
- action?: Slot<'div'>;
9
- };
10
- /**
11
- * CardHeader props
12
- */
13
- export declare type CardHeaderProps = ComponentProps<Partial<CardHeaderSlots>>;
14
- /**
15
- * State used in rendering CardHeader
16
- */
17
- export declare type CardHeaderState = ComponentState<CardHeaderSlots>;
@@ -1,5 +0,0 @@
1
- export * from './CardHeader';
2
- export * from './CardHeader.types';
3
- export * from './renderCardHeader';
4
- export * from './useCardHeader';
5
- export * from './useCardHeaderStyles';
@@ -1,5 +0,0 @@
1
- import type { CardHeaderState } from './CardHeader.types';
2
- /**
3
- * Render the final JSX of CardHeader
4
- */
5
- export declare const renderCardHeader_unstable: (state: CardHeaderState) => JSX.Element;
@@ -1,12 +0,0 @@
1
- import * as React from 'react';
2
- import type { CardHeaderProps, CardHeaderState } from './CardHeader.types';
3
- /**
4
- * Create the state required to render CardHeader.
5
- *
6
- * The returned state can be modified with hooks such as useCardHeaderStyles_unstable,
7
- * before being passed to renderCardHeader_unstable.
8
- *
9
- * @param props - props from this instance of CardHeader
10
- * @param ref - reference to root HTMLElement of CardHeader
11
- */
12
- export declare const useCardHeader_unstable: (props: CardHeaderProps, ref: React.Ref<HTMLElement>) => CardHeaderState;
@@ -1,11 +0,0 @@
1
- import type { SlotClassNames } from '@fluentui/react-utilities';
2
- import type { CardHeaderSlots, CardHeaderState } from './CardHeader.types';
3
- /**
4
- * @deprecated Use `cardHeaderClassNames.root` instead.
5
- */
6
- export declare const cardHeaderClassName = "fui-CardHeader";
7
- export declare const cardHeaderClassNames: SlotClassNames<CardHeaderSlots>;
8
- /**
9
- * Apply styling to the CardHeader slots based on the state
10
- */
11
- export declare const useCardHeaderStyles_unstable: (state: CardHeaderState) => CardHeaderState;
@@ -1,6 +0,0 @@
1
- import type { CardPreviewProps } from './CardPreview.types';
2
- import type { ForwardRefComponent } from '@fluentui/react-utilities';
3
- /**
4
- * Component to render image previews of documents or articles in a Card component.
5
- */
6
- export declare const CardPreview: ForwardRefComponent<CardPreviewProps>;
@@ -1,13 +0,0 @@
1
- import type { ComponentProps, ComponentState, Slot } from '@fluentui/react-utilities';
2
- export declare type CardPreviewSlots = {
3
- root: Slot<'div'>;
4
- logo?: Slot<'div'>;
5
- };
6
- /**
7
- * CardPreview props
8
- */
9
- export declare type CardPreviewProps = ComponentProps<CardPreviewSlots>;
10
- /**
11
- * State used in rendering CardPreview
12
- */
13
- export declare type CardPreviewState = ComponentState<CardPreviewSlots>;
@@ -1,5 +0,0 @@
1
- export * from './CardPreview';
2
- export * from './CardPreview.types';
3
- export * from './renderCardPreview';
4
- export * from './useCardPreview';
5
- export * from './useCardPreviewStyles';
@@ -1,5 +0,0 @@
1
- import type { CardPreviewState } from './CardPreview.types';
2
- /**
3
- * Render the final JSX of CardPreview
4
- */
5
- export declare const renderCardPreview_unstable: (state: CardPreviewState) => JSX.Element;
@@ -1,12 +0,0 @@
1
- import * as React from 'react';
2
- import type { CardPreviewProps, CardPreviewState } from './CardPreview.types';
3
- /**
4
- * Create the state required to render CardPreview.
5
- *
6
- * The returned state can be modified with hooks such as useCardPreviewStyles_unstable,
7
- * before being passed to renderCardPreview_unstable.
8
- *
9
- * @param props - props from this instance of CardPreview
10
- * @param ref - reference to root HTMLElement of CardPreview
11
- */
12
- export declare const useCardPreview_unstable: (props: CardPreviewProps, ref: React.Ref<HTMLElement>) => CardPreviewState;
@@ -1,11 +0,0 @@
1
- import type { SlotClassNames } from '@fluentui/react-utilities';
2
- import type { CardPreviewSlots, CardPreviewState } from './CardPreview.types';
3
- /**
4
- * @deprecated Use `cardPreviewClassNames.root` instead.
5
- */
6
- export declare const cardPreviewClassName = "fui-CardPreview";
7
- export declare const cardPreviewClassNames: SlotClassNames<CardPreviewSlots>;
8
- /**
9
- * Apply styling to the CardPreview slots based on the state
10
- */
11
- export declare const useCardPreviewStyles_unstable: (state: CardPreviewState) => CardPreviewState;
@@ -1,8 +0,0 @@
1
- export { Card, cardClassName, cardClassNames, renderCard_unstable, useCardStyles_unstable, useCard_unstable, } from './Card';
2
- export type { CardCommons, CardProps, CardSlots, CardState } from './Card';
3
- export { CardFooter, cardFooterClassName, cardFooterClassNames, renderCardFooter_unstable, useCardFooterStyles_unstable, useCardFooter_unstable, } from './CardFooter';
4
- export type { CardFooterProps, CardFooterSlots, CardFooterState } from './CardFooter';
5
- export { CardHeader, cardHeaderClassName, cardHeaderClassNames, renderCardHeader_unstable, useCardHeaderStyles_unstable, useCardHeader_unstable, } from './CardHeader';
6
- export type { CardHeaderProps, CardHeaderSlots, CardHeaderState } from './CardHeader';
7
- export { CardPreview, cardPreviewClassName, cardPreviewClassNames, renderCardPreview_unstable, useCardPreviewStyles_unstable, useCardPreview_unstable, } from './CardPreview';
8
- export type { CardPreviewProps, CardPreviewSlots, CardPreviewState } from './CardPreview';