Skip to main content

Usage

The targets of the below example:

  • Show a button showing the text 'Submit'.
  • After clicking the button, change the button text to 'Loading' and send an HTTP request.
  • Upon successful request, change the button text to 'Done' as success notification.
import { useState } from 'react';
import ReactiveButton from 'reactive-button';

function App() {
const [state, setState] = useState('idle');

const onClickHandler = () => {
setState('loading');

// send an HTTP request
setTimeout(() => {
setState('success');
}, 2000);
};

return (
<ReactiveButton
buttonState={state}
idleText="Submit"
loadingText="Loading"
successText="Done"
onClick={onClickHandler}
/>
);
}

export default App;

Other Usage

Reactive Button has all the functionalities of a normal button.

Color

Reactive Button comes with 10 default color options.

return (
<>
<ReactiveButton color="primary" />
<ReactiveButton color="secondary" />
<ReactiveButton color="teal" />
<ReactiveButton color="green" />
<ReactiveButton color="red" />
<ReactiveButton color="violet" />
<ReactiveButton color="blue" />
<ReactiveButton color="yellow" />
<ReactiveButton color="dark" />
<ReactiveButton color="light" />
</>
);

Size

There are 4 sizes available.

return (
<>
<ReactiveButton size="tiny" />
<ReactiveButton size="small" />
<ReactiveButton size="medium" />
<ReactiveButton size="large" />
</>
);

Style

Make the buttons more beautiful with these customization options.

return (
<>
<ReactiveButton outline />
<ReactiveButton rounded />
<ReactiveButton shadow />
</>
);

Existing State

In your project, There might be existing state for loading indicator which accepts boolean value only. If you don't want to define new state for Reactive Button, then utilize the existing state.

const [loading, setLoading] = useState(false);

return (
<ReactiveButton
buttonState={loading ? 'loading' : 'idle'}
idleText={'Button'}
loadingText={'Loading'}
/>
);

Without State

state is not mandatory.

return <ReactiveButton onClick={onClickHandler} />;

Using Icons

You can use your own icons. Don't forget to wrap them with a parent element.

return (
<ReactiveButton
idleText={
<span>
<faReply /> Send
</span>
}
/>
);

Form Submit

If you need to submit form by button clicking, set the type prop as 'submit'.

return (
<form>
<input type="text" name="username" />
<input type="password" name="password" />
<ReactiveButton type={'submit'} idleText="Submit" />
</form>
);

Anchor Tag

To use Reactive button as anchor tag, simply wrap it with an anchor tag.

return (
<a href="https://github.com/" target="_blank">
<ReactiveButton idleText="Visit Github" />
</a>
);
Note: For more usage, visit Playground.

Available Props

PropsTypeDescriptionDefault
buttonStatestring'idle' | 'loading' | 'success' | 'error''idle'
onClickfunctionCallback function when clicking button() => {}
colorstring'primary' | 'secondary' | 'dark' | 'light' | 'green' | 'red' | 'yellow' | 'teal' | 'violet' | 'blue''primary'
idleTextstring | ReactNodeButton text when idle'Click Me'
loadingTextstring | ReactNodeButton text when loading'Loading'
successTextstring | ReactNodeButton text when loading successful'Success'
errorTextstring | ReactNodeButton text when loading failed'Error'
typestring'button' | 'submit' | 'reset''button'
classNamestringButton classnames''
styleReact.CSSPropertiesCustom style{}
outlinebooleanEnable outline effectfalse
shadowbooleanEnable shadow effectfalse
roundedbooleanEnable rounded buttonfalse
sizestring'tiny' | 'small' | 'normal' | 'large''normal'
blockbooleanBlock Buttonfalse
messageDurationnumberSuccess/Error message duration in millisecond2000
disabledbooleanDisable buttonfalse
buttonRefReact.Ref | nullButton referencenull
widthstring | nullOverride button widthnull
heightstring | nullOverride button heightnull
animationbooleanButton hover and click animationtrue