1.2.2 β€’ Published 12 months ago

@baronha/ting v1.2.2

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

Logo1.2.2 BuyMeACoffee Kofi

Overview

Turbo Native Modules Swift Kotlin

🍞 Flexible and customizable React toast notifications with support for positioning, custom rendering, click handlers, and duration control.

Video Demo πŸ“Ί

iosandroidModal

Installation

yarn add @baronha/ting
or
npm i @baronha/ting

If you want to use Expo. Burnt is the solution for you.

iOS

New Architecture

cd ios && RCT_NEW_ARCH_ENABLED=1 bundle exec pod install --verbose

Older

cd ios && pod install --verbose

Usage

Toast

import { toast } from '@baronha/ting';
// ...
const options = {
  title: 'Done 😎',
  message: 'Successful!!',
};

toast(options); // easy to use

Customize Icon

import { toast } from '@baronha/ting';
// ...
const options = {
  // ...
  title: 'Vietnamese Gangz 😎',
  message: 'Anh em tao lΓ  Vietnamese Gangz',
  titleColor: '#D60A2E',
  icon: {
    uri: require('./vietnam.png'), // or remote
    size: 24,
  },
};

toast(options); // icon is πŸ‡»πŸ‡³

Alert

import { alert } from '@baronha/ting';
// ...
const options = {
  title: 'Done 😎',
  message: 'Successful!!',
};

alert(options); // easy to use

Initialization

Instead of using too many options like this:

const options = {
  // ...
  messageColor: '#D60A2E',
  titleColor: '#D60A2E',
  icon: {
    uri: require('./vietnam.png'), // or remote
    size: 24,
  },
  shouldDismissByTap: true,
  position: 'bottom',
  // ... bla bla bla
};

toast(options);

You want to initialize the default options for all subsequent use of toast or alert. You can use the setup function that is called when the application is initialized. Do the following:

import { setup } from '@baronha/ting';

const initOption = {
  toast: {
    messageColor: '#D60A2E',
    titleColor: '#D60A2E',
    backgroundColor: '#ffffff',
    // ... more and more
  },
  alert: {
    // ... alert's option
  },
};

setup(initOption);

// Use it next time. You can completely override it on subsequent calls
toast({
  title: 'Ting!',
  message: 'Easy toast for React Native',
});

alert({
  title: "What's up bruhhh!",
  message: 'Easy Alert for React Native',
});

Options

PropertyTypeDefault valuePlatformToastAlertDescription
titlestringnullBothβœ…βœ…
messagestringnullBothβœ…βœ…
titleColorstringnullBothβœ…βœ…The color of the title text in hexadecimal format (e.g., #FF0000)
messageColorstringnullBothβœ…βœ…The color of the message text in hexadecimal format (e.g., #00FF00)
iconobjectnullBothβœ…βœ…See Icon
presetstringdoneBothβœ…βœ…done, error, none, spinner
durationnumber3Bothβœ…βœ…The lifetime of the toast (seconds)
titleColorstringnullBothβœ…βœ…
shouldDismissByDragbooleantrueBothβœ…
positionstringtopBothβœ…Toast is displayed from top or bottom
hapticstringnulliOSβœ…success, warning, error, none
shouldDismissByTapbooleantrueBothβœ…
borderRadiusnumbernullBothβœ…
blurBackdropnumbernullAndroidβœ…
backdropOpacitynumbernullAndroidβœ…
backgroundColorstring#ffffffBothβœ…βœ…The background color of the toast in hexadecimal format (e.g., #0000FF)

Icon

iconTypeDefault valuePlatform
uristringnullBoth
sizenumbernullBoth
tintColorstringnullBoth

To Do

  • Initialize for the first time (v.1.0.5)
  • tintColor for icon (v.1.0.5)
  • backgroundColor (v.1.0.3)
  • spinner preset for toast (v.1.1.0)
  • custom color like StyleSheet (e.g. #fff, red, rgba(0, 0, 0, .8))
  • shouldDismissByDrag on Android
  • callback

Performance

We're trying to improve performance. If you have a better solution, please open a issue or pull request. Best regards!

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

Contributors ✨

Thanks go to these wonderful people:

License

MIT AlertKit SPIndicator EasyWindow

1.2.2

12 months ago

1.2.1

1 year ago

1.2.0

1 year ago

1.1.0

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago