Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@gluestack-ui/spinner

gluestack162.6k0.1.15TypeScript support: included

A universal headless Spinner component for React Native, Next.js & React

react, native, react-native, spinner, gluestack-ui, universal, headless, typescript, component, android, ios, nextjs

readme

@gluestack-ui/spinner

Installation

To use @gluestack-ui/spinner, all you need to do is install the @gluestack-ui/spinner package:

$ yarn add @gluestack-ui/spinner

# or

$ npm i @gluestack-ui/spinner

Usage

Spinners are designed to give visual cues to users that an action is being processed or that a change or result is expected. They are useful for improving the user experience by reducing frustration and uncertainty. Here's an example how to use this package to create one:

import { createSpinner } from '@gluestack-ui/spinner';
import { Root } from './styled-components';

export const Spinner = createSpinner({ Root });

Customizing the Spinner:

Default styling of all these components can be found in the components/core/spinner file. For reference, you can view the source code of the styled Spinner components.

// import the styles
import { Root } from '../components/core/spinner/styled-components';

// import the createSpinner function
import { createSpinner } from '@gluestack-ui/spinner';

// Understanding the API
const Spinner = createSpinner({
  Root,
});

// Using the spinner component
export default () => <Spinner />;

More guides on how to get started are available here.

changelog

Changelog

Latest Release

December 23, 2022: v0.1.0

Previous Releases