@storybook/react-native

@storybook/react-native

Version 5.3.27
Published 4 months ago
97.6 kB
10 dependencies
MIT license

Install

npm i @storybook/react-native

yarn add @storybook/react-native

pnpm add @storybook/react-native

Overview

A better way to develop React Native Components for your app

Index

Variables

addDecorator
addParameters
clearDecorators
getStorybook
raw
setAddon

Functions

configure()
getStorybookUI()
storiesOf()

Variables

variable addDecorator

const addDecorator: ClientApi;

variable addParameters

const addParameters: ClientApi;

variable clearDecorators

const clearDecorators: ClientApi;

variable getStorybook

const getStorybook: ClientApi;

variable raw

const raw: ClientApi;

variable setAddon

const setAddon: ClientApi;

Functions

function configure

configure: (loadStories: () => void, module: any) => void;

function getStorybookUI

getStorybookUI: (params?: Partial<import('./preview').Params>) => {
    new (props: Readonly<{}>): {
        render(): JSX.Element;
        context: any;
        setState<K extends never>(
            state:
                | {}
                | ((
                      prevState: Readonly<{}>,
                      props: Readonly<{}>
                  ) => {} | Pick<{}, K>)
                | Pick<{}, K>,
            callback?: () => void
        ): void;
        forceUpdate(callback?: () => void): void;
        readonly props: Readonly<{}> & Readonly<{ children?: ReactNode }>;
        state: Readonly<{}>;
        refs: { [key: string]: any };
        componentDidMount?(): void;
        shouldComponentUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): boolean;
        componentWillUnmount?(): void;
        componentDidCatch?(error: Error, errorInfo: any): void;
        getSnapshotBeforeUpdate?(
            prevProps: Readonly<{}>,
            prevState: Readonly<{}>
        ): any;
        componentDidUpdate?(
            prevProps: Readonly<{}>,
            prevState: Readonly<{}>,
            snapshot?: any
        ): void;
        componentWillMount?(): void;
        UNSAFE_componentWillMount?(): void;
        componentWillReceiveProps?(nextProps: Readonly<{}>, nextContext: any): void;
        UNSAFE_componentWillReceiveProps?(
            nextProps: Readonly<{}>,
            nextContext: any
        ): void;
        componentWillUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): void;
        UNSAFE_componentWillUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): void;
    };
    new (props: {}, context?: any): {
        render(): JSX.Element;
        context: any;
        setState<K extends never>(
            state:
                | {}
                | ((
                      prevState: Readonly<{}>,
                      props: Readonly<{}>
                  ) => {} | Pick<{}, K>)
                | Pick<{}, K>,
            callback?: () => void
        ): void;
        forceUpdate(callback?: () => void): void;
        readonly props: Readonly<{}> & Readonly<{ children?: ReactNode }>;
        state: Readonly<{}>;
        refs: { [key: string]: any };
        componentDidMount?(): void;
        shouldComponentUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): boolean;
        componentWillUnmount?(): void;
        componentDidCatch?(error: Error, errorInfo: any): void;
        getSnapshotBeforeUpdate?(
            prevProps: Readonly<{}>,
            prevState: Readonly<{}>
        ): any;
        componentDidUpdate?(
            prevProps: Readonly<{}>,
            prevState: Readonly<{}>,
            snapshot?: any
        ): void;
        componentWillMount?(): void;
        UNSAFE_componentWillMount?(): void;
        componentWillReceiveProps?(nextProps: Readonly<{}>, nextContext: any): void;
        UNSAFE_componentWillReceiveProps?(
            nextProps: Readonly<{}>,
            nextContext: any
        ): void;
        componentWillUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): void;
        UNSAFE_componentWillUpdate?(
            nextProps: Readonly<{}>,
            nextState: Readonly<{}>,
            nextContext: any
        ): void;
    };
    contextType?: any;
};

function storiesOf

storiesOf: (kind: string, module: NodeModule) => StoryApi<ReactNode>;

Package Files (1)

dist/index.d.ts

Dev Dependencies (1)

@types/react-native

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@storybook/react-native.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@storybook/react-native)

HTML

<a href="https://www.jsdocs.io/package/@storybook/react-native"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 4 months ago.
Package analyzed in 3764 ms.
Missing or incorrect documentation? Open an issue for this package.

@storybook/react-native

Install

Overview

Index

Variables

Functions

Variables

variable addDecorator

variable addParameters

variable clearDecorators

variable getStorybook

variable raw

variable setAddon

Functions

function configure

function getStorybookUI

function storiesOf

Package Files (1)

Dependencies (10)

Dev Dependencies (1)

Peer Dependencies (2)

Badge