Back to Fluentui

React Storybook Addon.Api

packages/react-components/react-storybook-addon/etc/react-storybook-addon.api.md

4.40.2-hotfix22.4 KB
Original Source

API Report File for "@fluentui/react-storybook-addon"

Do not edit this file. It is a report generated by API Extractor.

ts

import { Args } from '@storybook/react-webpack5';
import type { JSXElement } from '@fluentui/react-utilities';
import { Parameters as Parameters_2 } from '@storybook/react-webpack5';
import * as React_2 from 'react';
import { StoryContext } from '@storybook/react-webpack5';

// @public (undocumented)
export const DIR_ID: "storybook_fluentui-react-addon_dir";

// @public
export const FluentCanvas: (props: React_2.ComponentProps<"div">) => JSXElement;

// @public
export interface FluentGlobals extends Args {
    // (undocumented)
    [DIR_ID]?: 'ltr' | 'rtl';
    // (undocumented)
    [STRICT_MODE_ID]?: boolean;
    // (undocumented)
    [THEME_ID]?: ThemeIds;
}

// @public
export interface FluentParameters extends Parameters_2 {
    // (undocumented)
    dir?: 'ltr' | 'rtl';
    // (undocumented)
    fluentTheme?: ThemeIds;
    // (undocumented)
    mode?: 'default' | 'vr-test';
    // (undocumented)
    reactStorybookAddon?: {
        disabledDecorators?: ['AriaLive' | 'FluentProvider' | 'ReactStrictMode'];
        docs?: FluentDocsConfig;
    };
}

// @public
export const FluentStory: ({ id, height }: FluentStoryProps) => JSXElement;

// @public (undocumented)
export interface FluentStoryContext extends StoryContext {
    // (undocumented)
    globals: FluentGlobals;
    // (undocumented)
    parameters: FluentParameters;
}

// @public (undocumented)
export function parameters(options?: FluentParameters): FluentParameters;

// @public (undocumented)
export const THEME_ID: "storybook_fluentui-react-addon_theme";

// @public (undocumented)
export type ThemeIds = (typeof themes)[number]['id'];

// @public (undocumented)
export const themes: readonly [{
    readonly id: "web-light";
    readonly label: "Web Light";
}, {
    readonly id: "web-dark";
    readonly label: "Web Dark";
}, {
    readonly id: "teams-light";
    readonly label: "Teams Light";
}, {
    readonly id: "teams-dark";
    readonly label: "Teams Dark";
}, {
    readonly id: "teams-light-v21";
    readonly label: "Teams Light V2.1";
}, {
    readonly id: "teams-dark-v21";
    readonly label: "Teams Dark V2.1";
}, {
    readonly id: "teams-high-contrast";
    readonly label: "Teams High Contrast";
}];

// (No @packageDocumentation comment for this package)