Skip to content

Commit

Permalink
chore: re-generare api.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
@Hotell
Hotell committed Jun 5, 2024
1 parent 6d661fd commit ad6d1b7
Show file tree
Hide file tree
Showing 9 changed files with 204 additions and 267 deletions.
90 changes: 40 additions & 50 deletions packages/react-components/react-rating/library/etc/react-rating.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

/// <reference types="react" />

import type { ComponentProps } from '@fluentui/react-utilities';
Expand All @@ -22,7 +23,7 @@ export const ratingClassNames: SlotClassNames<RatingSlots>;

// @public (undocumented)
export type RatingContextValues = {
ratingItem: RatingItemContextValue;
ratingItem: RatingItemContextValue;
};

// @public
Expand All @@ -33,31 +34,29 @@ export const ratingDisplayClassNames: SlotClassNames<RatingDisplaySlots>;

// @public (undocumented)
export type RatingDisplayContextValues = {
ratingItem: RatingItemContextValue;
ratingItem: RatingItemContextValue;
};

// @public
export type RatingDisplayProps = ComponentProps<RatingDisplaySlots> & {
color?: 'brand' | 'marigold' | 'neutral';
compact?: boolean;
count?: number;
icon?: React_2.ElementType;
max?: number;
size?: 'small' | 'medium' | 'large' | 'extra-large';
value?: number;
color?: 'brand' | 'marigold' | 'neutral';
compact?: boolean;
count?: number;
icon?: React_2.ElementType;
max?: number;
size?: 'small' | 'medium' | 'large' | 'extra-large';
value?: number;
};

// @public (undocumented)
export type RatingDisplaySlots = {
root: NonNullable<Slot<'div'>>;
valueText?: Slot<'span'>;
countText?: Slot<'span'>;
root: NonNullable<Slot<'div'>>;
valueText?: Slot<'span'>;
countText?: Slot<'span'>;
};

// @public
export type RatingDisplayState = ComponentState<RatingDisplaySlots> &
Required<Pick<RatingDisplayProps, 'color' | 'compact' | 'icon' | 'max' | 'size'>> &
Pick<RatingDisplayProps, 'value'>;
export type RatingDisplayState = ComponentState<RatingDisplaySlots> & Required<Pick<RatingDisplayProps, 'color' | 'compact' | 'icon' | 'max' | 'size'>> & Pick<RatingDisplayProps, 'value'>;

// @public
export const RatingItem: ForwardRefComponent<RatingItemProps>;
Expand All @@ -67,69 +66,62 @@ export const ratingItemClassNames: SlotClassNames<RatingItemSlots>;

// @public
export type RatingItemProps = ComponentProps<Partial<RatingItemSlots>> & {
value?: number;
value?: number;
};

// @public (undocumented)
export const RatingItemProvider: React_2.Provider<RatingItemContextValue | undefined>;

// @public (undocumented)
export type RatingItemSlots = {
root: NonNullable<Slot<'span'>>;
selectedIcon?: NonNullable<Slot<'div'>>;
unselectedIcon?: NonNullable<Slot<'div'>>;
halfValueInput?: NonNullable<Slot<'input'>>;
fullValueInput?: NonNullable<Slot<'input'>>;
root: NonNullable<Slot<'span'>>;
selectedIcon?: NonNullable<Slot<'div'>>;
unselectedIcon?: NonNullable<Slot<'div'>>;
halfValueInput?: NonNullable<Slot<'input'>>;
fullValueInput?: NonNullable<Slot<'input'>>;
};

// @public
export type RatingItemState = ComponentState<RatingItemSlots> &
Required<Pick<RatingItemProps, 'value'>> &
Pick<RatingState, 'color' | 'step' | 'size'> & {
export type RatingItemState = ComponentState<RatingItemSlots> & Required<Pick<RatingItemProps, 'value'>> & Pick<RatingState, 'color' | 'step' | 'size'> & {
iconFillWidth: number;
appearance: 'outline' | 'filled';
};
};

// @public
export type RatingOnChangeEventData = EventData<'change', React_2.FormEvent<HTMLDivElement>> & {
value: number;
value: number;
};

// @public
export type RatingProps = Omit<ComponentProps<Partial<RatingSlots>>, 'onChange'> & {
color?: 'brand' | 'marigold' | 'neutral';
defaultValue?: number;
iconFilled?: React_2.ElementType;
iconOutline?: React_2.ElementType;
itemLabel?: (rating: number) => string;
max?: number;
name?: string;
onChange?: EventHandler<RatingOnChangeEventData>;
step?: 0.5 | 1;
size?: 'small' | 'medium' | 'large' | 'extra-large';
value?: number;
color?: 'brand' | 'marigold' | 'neutral';
defaultValue?: number;
iconFilled?: React_2.ElementType;
iconOutline?: React_2.ElementType;
itemLabel?: (rating: number) => string;
max?: number;
name?: string;
onChange?: EventHandler<RatingOnChangeEventData>;
step?: 0.5 | 1;
size?: 'small' | 'medium' | 'large' | 'extra-large';
value?: number;
};

// @public (undocumented)
export type RatingSlots = {
root: NonNullable<Slot<'div'>>;
root: NonNullable<Slot<'div'>>;
};

// @public
export type RatingState = ComponentState<RatingSlots> &
Required<Pick<RatingProps, 'color' | 'iconFilled' | 'iconOutline' | 'name' | 'step' | 'size' | 'value'>> &
Pick<RatingProps, 'itemLabel'> & {
export type RatingState = ComponentState<RatingSlots> & Required<Pick<RatingProps, 'color' | 'iconFilled' | 'iconOutline' | 'name' | 'step' | 'size' | 'value'>> & Pick<RatingProps, 'itemLabel'> & {
hoveredValue?: number | undefined;
};
};

// @public
export const renderRating_unstable: (state: RatingState, contextValues: RatingContextValues) => JSX.Element;

// @public
export const renderRatingDisplay_unstable: (
state: RatingDisplayState,
contextValues: RatingDisplayContextValues,
) => JSX.Element;
export const renderRatingDisplay_unstable: (state: RatingDisplayState, contextValues: RatingDisplayContextValues) => JSX.Element;

// @public
export const renderRatingItem_unstable: (state: RatingItemState) => JSX.Element;
Expand All @@ -141,10 +133,7 @@ export const useRating_unstable: (props: RatingProps, ref: React_2.Ref<HTMLDivEl
export const useRatingContextValues: (ratingState: RatingState) => RatingContextValues;

// @public
export const useRatingDisplay_unstable: (
props: RatingDisplayProps,
ref: React_2.Ref<HTMLDivElement>,
) => RatingDisplayState;
export const useRatingDisplay_unstable: (props: RatingDisplayProps, ref: React_2.Ref<HTMLDivElement>) => RatingDisplayState;

// @public (undocumented)
export const useRatingDisplayContextValues: (state: RatingDisplayState) => RatingDisplayContextValues;
Expand All @@ -165,4 +154,5 @@ export const useRatingItemStyles_unstable: (state: RatingItemState) => RatingIte
export const useRatingStyles_unstable: (state: RatingState) => RatingState;

// (No @packageDocumentation comment for this package)

```
19 changes: 7 additions & 12 deletions packages/react-components/react-search/library/etc/react-search.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

/// <reference types="react" />

import type { ComponentProps } from '@fluentui/react-utilities';
Expand All @@ -29,26 +30,19 @@ export type SearchBoxChangeEvent = React_2.ChangeEvent<HTMLInputElement> | React
export const searchBoxClassNames: SlotClassNames<SearchBoxSlots>;

// @public
export type SearchBoxProps = Omit<
ComponentProps<Partial<SearchBoxSlots>, 'input'>,
'children' | 'defaultValue' | 'onChange' | 'size' | 'type' | 'value'
> &
Omit<InputProps, 'onChange'> & {
export type SearchBoxProps = Omit<ComponentProps<Partial<SearchBoxSlots>, 'input'>, 'children' | 'defaultValue' | 'onChange' | 'size' | 'type' | 'value'> & Omit<InputProps, 'onChange'> & {
onChange?: (event: SearchBoxChangeEvent, data: InputOnChangeData) => void;
};
};

// @public (undocumented)
export type SearchBoxSlots = InputSlots & {
dismiss?: Slot<'span'>;
dismiss?: Slot<'span'>;
};

// @public
export type SearchBoxState = ComponentState<SearchBoxSlots> &
InputState &
Required<Pick<InputState, 'size'>> &
Required<Pick<SearchBoxProps, 'disabled'>> & {
export type SearchBoxState = ComponentState<SearchBoxSlots> & InputState & Required<Pick<InputState, 'size'>> & Required<Pick<SearchBoxProps, 'disabled'>> & {
focused: boolean;
};
};

// @public
export const useSearchBox_unstable: (props: SearchBoxProps, ref: React_2.Ref<HTMLInputElement>) => SearchBoxState;
Expand All @@ -57,4 +51,5 @@ export const useSearchBox_unstable: (props: SearchBoxProps, ref: React_2.Ref<HTM
export const useSearchBoxStyles_unstable: (state: SearchBoxState) => SearchBoxState;

// (No @packageDocumentation comment for this package)

```
45 changes: 22 additions & 23 deletions packages/react-components/react-slider/library/etc/react-slider.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

/// <reference types="react" />

import type { ComponentProps } from '@fluentui/react-utilities';
Expand All @@ -23,40 +24,37 @@ export const sliderClassNames: SlotClassNames<SliderSlots>;

// @public (undocumented)
export const sliderCSSVars: {
sliderDirectionVar: string;
sliderProgressVar: string;
sliderStepsPercentVar: string;
sliderDirectionVar: string;
sliderProgressVar: string;
sliderStepsPercentVar: string;
};

// @public (undocumented)
export type SliderOnChangeData = {
value: number;
value: number;
};

// @public (undocumented)
export type SliderProps = Omit<
ComponentProps<Partial<SliderSlots>, 'input'>,
'defaultValue' | 'onChange' | 'size' | 'value'
> & {
defaultValue?: number;
disabled?: boolean;
max?: number;
min?: number;
size?: 'small' | 'medium';
step?: number;
value?: number;
vertical?: boolean;
onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: SliderOnChangeData) => void;
export type SliderProps = Omit<ComponentProps<Partial<SliderSlots>, 'input'>, 'defaultValue' | 'onChange' | 'size' | 'value'> & {
defaultValue?: number;
disabled?: boolean;
max?: number;
min?: number;
size?: 'small' | 'medium';
step?: number;
value?: number;
vertical?: boolean;
onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: SliderOnChangeData) => void;
};

// @public (undocumented)
export type SliderSlots = {
root: NonNullable<Slot<'div'>>;
rail: NonNullable<Slot<'div'>>;
thumb: NonNullable<Slot<'div'>>;
input: NonNullable<Slot<'input'>> & {
orient?: 'horizontal' | 'vertical';
};
root: NonNullable<Slot<'div'>>;
rail: NonNullable<Slot<'div'>>;
thumb: NonNullable<Slot<'div'>>;
input: NonNullable<Slot<'input'>> & {
orient?: 'horizontal' | 'vertical';
};
};

// @public (undocumented)
Expand All @@ -72,4 +70,5 @@ export const useSliderState_unstable: (state: SliderState, props: SliderProps) =
export const useSliderStyles_unstable: (state: SliderState) => SliderState;

// (No @packageDocumentation comment for this package)

```
52 changes: 23 additions & 29 deletions packages/react-components/react-spinbutton/library/etc/react-spinbutton.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts

/// <reference types="react" />

import type { ComponentProps } from '@fluentui/react-utilities';
Expand All @@ -22,56 +23,48 @@ export const SpinButton: ForwardRefComponent<SpinButtonProps>;
export type SpinButtonBounds = 'none' | 'min' | 'max' | 'both';

// @public (undocumented)
export type SpinButtonChangeEvent =
| React_2.MouseEvent<HTMLButtonElement>
| React_2.ChangeEvent<HTMLElement>
| React_2.FocusEvent<HTMLInputElement>
| React_2.KeyboardEvent<HTMLInputElement>;
export type SpinButtonChangeEvent = React_2.MouseEvent<HTMLButtonElement> | React_2.ChangeEvent<HTMLElement> | React_2.FocusEvent<HTMLInputElement> | React_2.KeyboardEvent<HTMLInputElement>;

// @public (undocumented)
export const spinButtonClassNames: SlotClassNames<SpinButtonSlots>;

// @public (undocumented)
export type SpinButtonOnChangeData = {
value?: number | null;
displayValue?: string;
value?: number | null;
displayValue?: string;
};

// @public
export type SpinButtonProps = Omit<
ComponentProps<Partial<SpinButtonSlots>, 'input'>,
'defaultValue' | 'onChange' | 'size' | 'value'
> & {
appearance?: 'outline' | 'underline' | 'filled-darker' | 'filled-lighter';
defaultValue?: number | null;
displayValue?: string;
max?: number;
min?: number;
onChange?: (event: SpinButtonChangeEvent, data: SpinButtonOnChangeData) => void;
precision?: number;
size?: 'small' | 'medium';
step?: number;
stepPage?: number;
value?: number | null;
export type SpinButtonProps = Omit<ComponentProps<Partial<SpinButtonSlots>, 'input'>, 'defaultValue' | 'onChange' | 'size' | 'value'> & {
appearance?: 'outline' | 'underline' | 'filled-darker' | 'filled-lighter';
defaultValue?: number | null;
displayValue?: string;
max?: number;
min?: number;
onChange?: (event: SpinButtonChangeEvent, data: SpinButtonOnChangeData) => void;
precision?: number;
size?: 'small' | 'medium';
step?: number;
stepPage?: number;
value?: number | null;
};

// @public (undocumented)
export type SpinButtonSlots = {
root: NonNullable<Slot<'span'>>;
input: NonNullable<Slot<'input'>>;
incrementButton: NonNullable<Slot<'button'>>;
decrementButton: NonNullable<Slot<'button'>>;
root: NonNullable<Slot<'span'>>;
input: NonNullable<Slot<'input'>>;
incrementButton: NonNullable<Slot<'button'>>;
decrementButton: NonNullable<Slot<'button'>>;
};

// @public (undocumented)
export type SpinButtonSpinState = 'rest' | 'up' | 'down';

// @public
export type SpinButtonState = ComponentState<SpinButtonSlots> &
Required<Pick<SpinButtonProps, 'appearance' | 'size'>> & {
export type SpinButtonState = ComponentState<SpinButtonSlots> & Required<Pick<SpinButtonProps, 'appearance' | 'size'>> & {
spinState: SpinButtonSpinState;
atBound: SpinButtonBounds;
};
};

// @public
export const useSpinButton_unstable: (props: SpinButtonProps, ref: React_2.Ref<HTMLInputElement>) => SpinButtonState;
Expand All @@ -80,4 +73,5 @@ export const useSpinButton_unstable: (props: SpinButtonProps, ref: React_2.Ref<H
export const useSpinButtonStyles_unstable: (state: SpinButtonState) => SpinButtonState;

// (No @packageDocumentation comment for this package)

```
Loading

0 comments on commit ad6d1b7

Please sign in to comment.