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 11, 2024
1 parent f02839d commit a08cc7e
Show file tree
Hide file tree
Showing 6 changed files with 130 additions and 183 deletions.
85 changes: 34 additions & 51 deletions packages/react-components/react-field/library/etc/react-field.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 @@ -20,70 +21,58 @@ export const Field: ForwardRefComponent<FieldProps>;
export const fieldClassNames: SlotClassNames<FieldSlots>;

// @public (undocumented)
export const FieldContextProvider: React_2.Provider<
| Readonly<
Pick<FieldState, 'required' | 'size' | 'orientation' | 'validationState' | 'generatedControlId'> & {
labelFor?: string | undefined;
labelId?: string | undefined;
validationMessageId?: string | undefined;
hintId?: string | undefined;
}
>
| undefined
>;
export const FieldContextProvider: React_2.Provider<Readonly<Pick<FieldState, "required" | "size" | "orientation" | "validationState" | "generatedControlId"> & {
labelFor?: string | undefined;
labelId?: string | undefined;
validationMessageId?: string | undefined;
hintId?: string | undefined;
}> | undefined>;

// @public (undocumented)
export type FieldContextValue = Readonly<
Pick<FieldState, 'generatedControlId' | 'orientation' | 'required' | 'size' | 'validationState'> & {
export type FieldContextValue = Readonly<Pick<FieldState, 'generatedControlId' | 'orientation' | 'required' | 'size' | 'validationState'> & {
labelFor?: string;
labelId?: string;
validationMessageId?: string;
hintId?: string;
}
>;
}>;

// @public (undocumented)
export type FieldContextValues = {
field: FieldContextValue;
field: FieldContextValue;
};

// @public
export type FieldControlProps = Pick<
React_2.HTMLAttributes<HTMLElement>,
'id' | 'aria-labelledby' | 'aria-describedby' | 'aria-invalid' | 'aria-required'
>;
export type FieldControlProps = Pick<React_2.HTMLAttributes<HTMLElement>, 'id' | 'aria-labelledby' | 'aria-describedby' | 'aria-invalid' | 'aria-required'>;

// @public
export type FieldControlPropsOptions = {
supportsLabelFor?: boolean;
supportsRequired?: boolean;
supportsSize?: boolean;
supportsLabelFor?: boolean;
supportsRequired?: boolean;
supportsSize?: boolean;
};

// @public
export type FieldProps = Omit<ComponentProps<FieldSlots>, 'children'> & {
children?: React_2.ReactNode | ((props: FieldControlProps) => React_2.ReactNode);
orientation?: 'vertical' | 'horizontal';
validationState?: 'error' | 'warning' | 'success' | 'none';
required?: boolean;
size?: 'small' | 'medium' | 'large';
children?: React_2.ReactNode | ((props: FieldControlProps) => React_2.ReactNode);
orientation?: 'vertical' | 'horizontal';
validationState?: 'error' | 'warning' | 'success' | 'none';
required?: boolean;
size?: 'small' | 'medium' | 'large';
};

// @public
export type FieldSlots = {
root: NonNullable<Slot<'div'>>;
label?: Slot<typeof Label>;
validationMessage?: Slot<'div'>;
validationMessageIcon?: Slot<'span'>;
hint?: Slot<'div'>;
root: NonNullable<Slot<'div'>>;
label?: Slot<typeof Label>;
validationMessage?: Slot<'div'>;
validationMessageIcon?: Slot<'span'>;
hint?: Slot<'div'>;
};

// @public
export type FieldState = ComponentState<Required<FieldSlots>> &
Required<Pick<FieldProps, 'orientation' | 'required' | 'size' | 'validationState'>> &
Pick<FieldProps, 'children'> & {
export type FieldState = ComponentState<Required<FieldSlots>> & Required<Pick<FieldProps, 'orientation' | 'required' | 'size' | 'validationState'>> & Pick<FieldProps, 'children'> & {
generatedControlId: string;
};
};

// @public
export const renderField_unstable: (state: FieldState, contextValues: FieldContextValues) => JSX.Element;
Expand All @@ -92,16 +81,12 @@ export const renderField_unstable: (state: FieldState, contextValues: FieldConte
export const useField_unstable: (props: FieldProps, ref: React_2.Ref<HTMLDivElement>) => FieldState;

// @public (undocumented)
export const useFieldContext_unstable: () =>
| Readonly<
Pick<FieldState, 'required' | 'size' | 'orientation' | 'validationState' | 'generatedControlId'> & {
labelFor?: string | undefined;
labelId?: string | undefined;
validationMessageId?: string | undefined;
hintId?: string | undefined;
}
>
| undefined;
export const useFieldContext_unstable: () => Readonly<Pick<FieldState, "required" | "size" | "orientation" | "validationState" | "generatedControlId"> & {
labelFor?: string | undefined;
labelId?: string | undefined;
validationMessageId?: string | undefined;
hintId?: string | undefined;
}> | undefined;

// @public
export const useFieldContextValues_unstable: (state: FieldState) => FieldContextValues;
Expand All @@ -110,13 +95,11 @@ export const useFieldContextValues_unstable: (state: FieldState) => FieldContext
export function useFieldControlProps_unstable(): FieldControlProps | undefined;

// @public
export function useFieldControlProps_unstable<Props extends FieldControlProps>(
props: Props,
options?: FieldControlPropsOptions,
): Props;
export function useFieldControlProps_unstable<Props extends FieldControlProps>(props: Props, options?: FieldControlPropsOptions): Props;

// @public
export const useFieldStyles_unstable: (state: FieldState) => FieldState;

// (No @packageDocumentation comment for this package)

```
49 changes: 15 additions & 34 deletions packages/react-components/react-input/library/etc/react-input.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 @@ -20,47 +21,26 @@ export const inputClassNames: SlotClassNames<InputSlots>;

// @public
export type InputOnChangeData = {
value: string;
value: string;
};

// @public (undocumented)
export type InputProps = Omit<
ComponentProps<Partial<InputSlots>, 'input'>,
'children' | 'defaultValue' | 'onChange' | 'size' | 'type' | 'value'
> & {
children?: never;
size?: 'small' | 'medium' | 'large';
appearance?:
| 'outline'
| 'underline'
| 'filled-darker'
| 'filled-lighter'
| 'filled-darker-shadow'
| 'filled-lighter-shadow';
defaultValue?: string;
value?: string;
onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: InputOnChangeData) => void;
type?:
| 'text'
| 'email'
| 'password'
| 'search'
| 'tel'
| 'url'
| 'date'
| 'datetime-local'
| 'month'
| 'number'
| 'time'
| 'week';
export type InputProps = Omit<ComponentProps<Partial<InputSlots>, 'input'>, 'children' | 'defaultValue' | 'onChange' | 'size' | 'type' | 'value'> & {
children?: never;
size?: 'small' | 'medium' | 'large';
appearance?: 'outline' | 'underline' | 'filled-darker' | 'filled-lighter' | 'filled-darker-shadow' | 'filled-lighter-shadow';
defaultValue?: string;
value?: string;
onChange?: (ev: React_2.ChangeEvent<HTMLInputElement>, data: InputOnChangeData) => void;
type?: 'text' | 'email' | 'password' | 'search' | 'tel' | 'url' | 'date' | 'datetime-local' | 'month' | 'number' | 'time' | 'week';
};

// @public (undocumented)
export type InputSlots = {
root: NonNullable<Slot<'span'>>;
input: NonNullable<Slot<'input'>>;
contentBefore?: Slot<'span'>;
contentAfter?: Slot<'span'>;
root: NonNullable<Slot<'span'>>;
input: NonNullable<Slot<'input'>>;
contentBefore?: Slot<'span'>;
contentAfter?: Slot<'span'>;
};

// @public
Expand All @@ -76,4 +56,5 @@ export const useInput_unstable: (props: InputProps, ref: React_2.Ref<HTMLInputEl
export const useInputStyles_unstable: (state: InputState) => InputState;

// (No @packageDocumentation comment for this package)

```
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)

```
Loading

0 comments on commit a08cc7e

Please sign in to comment.