jiku-ui/types/message.d.ts

A Component Library for Vue.js.

import Vue, {VNode} from 'vue'

export type MessageType = 'success' | 'warning' | 'info' | 'error'

/** Message Component */
export declare class HnMessageComponent extends Vue {
  /** Close the Loading instance */
  close (): void
}

export interface CloseEventHandler {
  /**
   * Triggers when a message is being closed
   *
   * @param instance The message component that is being closed
   */
  (instance: HnMessageComponent): void
}

/** Options used in Message */
export interface HnMessageOptions {
  /** Message text */
  message: string | VNode

  /** Message type */
  type?: MessageType

  /** Custom icon's class, overrides type */
  iconClass?: string

  /** Custom class name for Message */
  customClass?: string

  /** Display duration, millisecond. If set to 0, it will not turn off automatically */
  duration?: number

  /** Whether to show a close button */
  showClose?: boolean

  /** Whether to center the text */
  center?: boolean

  /** Whether message is treated as HTML string */
  dangerouslyUseHTMLString?: boolean

  /** Callback function when closed with the message instance as the parameter */
  onClose?: CloseEventHandler
  
  /** Set the distance to the top of viewport. Default is 20 px. */
  offset?: number
}

export interface HnMessage {
  /** Show an info message */
  (text: string): HnMessageComponent

  /** Show message */
  (options: HnMessageOptions): HnMessageComponent

  /** Show a success message */
  success (text: string): HnMessageComponent
  
  /** Show a success message with options */
  success (options: HnMessageOptions): HnMessageComponent

  /** Show a warning message */
  warning (text: string): HnMessageComponent
  
  /** Show a warning message with options */
  warning (options: HnMessageOptions): HnMessageComponent

  /** Show an info message */
  info (text: string): HnMessageComponent
  
  /** Show an info message with options */
  info (options: HnMessageOptions): HnMessageComponent

  /** Show an error message */
  error (text: string): HnMessageComponent
  
  /** Show an error message with options */
  error (options: HnMessageOptions): HnMessageComponent
}

declare module 'vue/types/vue' {
  interface Vue {
  /** Used to show feedback after an activity. The difference with Notification is that the latter is often used to show a system level passive notification. */
    $message: HnMessage
  }
}