Giter VIP home page Giter VIP logo

vkui-no-connection-modal's Introduction

VKUI NO INTERNET MODAL

Simple UI component for show network status. Component based on VKUI and designed for vk mini apps.

Features

  • Supported all VKUI themes
  • Auto close modal when user online
  • Check connect when user try close modal

Install

yarn add vkui-no-connection-modal

Example

import NoConnectionModal from 'vkui-no-connection-modal';
import useConnection from 'vkui-no-connection-modal/lib/useConnection';

const YourView = () => {
    const [modal, setModal] = useState(null);
    const isOnline = useConnection();

    useEffect(() => {
		if (!isOnline) return setModal(
			<NoConnectionModal 
				onClose={() => setModal(null)}
			/>
		);

		return setModal(null);
	}, [isOnline]);

    return (
        <View activePanel="modals" modal={modal}>
            <Panel id="modals">
                <Group>
                    Your view
                </Group>
            </Panel>
        </View>
    );
};

Options

You can passed options for component:

Name Type Description Default
header string Modal title 'No internet'
subHeader string Modal description 'Checking the network cables, modem and router.'
actionText string Button text 'Try again'
onClose function Close modal function Required

Demo

Start storybook

yarn start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/featureName)
  3. Commit your Changes (git commit -m 'Add some featureName')
  4. Push to the Branch (git push origin feature/featureName)
  5. Open a Pull Request

Credits

A big thanks to:

  • VKUI - Component based on VKUI

vkui-no-connection-modal's People

Contributors

aspedm avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.