Skip to content

πŸ’¬ React Message is a πŸš€ React component library for displaying customizable messages and notifications to users. It's easy to integrate and supports features like animations and timeout.

Notifications You must be signed in to change notification settings

reactify-component/react-message

Repository files navigation

React Message

A simple asynchronous React message popup utility, no needed React Context. So you can use it in anywhere. You just need to install React.

Requirement:

  • React 18
  • React DOM 18

NOTE: If you use React 17, please use version 0.2

How to use

npm i react-message-popup
import { message } from 'react-message-popup'

message.success('成功', 4000)
// etc.

message.loading('Loading...', 4000).then(({ next }) => {
  setTimeout(() => {
    next('成功', 'success')
  }, 2000)
})

message.success('成功', 4000).then(({ destory }) => {
  setTimeout(() => {
    destory()
  }, 2000)
})

Interface

export interface ArgsProps {
  content: string
  duration?: number | null
  key?: string | number
}
type JointContent = ConfigContent | ArgsProps
type ConfigContent = string
type ConfigDuration = number | (() => number)
export interface MessageInstance {
  info(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
  success(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
  error(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
  warning(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
  warn(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
  loading(
    content: JointContent,
    duration?: ConfigDuration,
  ): Promise<MessageReturnType>
}

export type MessageReturnType = {
  destory(): boolean
  next(message: string, type?: MessageType): void
}

About

πŸ’¬ React Message is a πŸš€ React component library for displaying customizable messages and notifications to users. It's easy to integrate and supports features like animations and timeout.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •