naive-ui/demo/documentation/components/notification/enUS/index.md
2020-01-30 23:23:51 +08:00

2.2 KiB

Notification

If something is to be telled to you.

UI has designed it long long ago. However, you know, it is always with low piority so I can make a lot of useless animations on it.

Demos

basic
type
change-content
scrollable
closable
duration

API

$NNotification API

Property Type Description
open (option: NotificationOption, type: string): NotificationEnvironment
success (option: NofiticationOption): NotificationEnvironment
info (option: NofiticationOption): NotificationEnvironment
warning (option: NofiticationOption): NotificationEnvironment
error (option: NofiticationOption): NotificationEnvironment
scrollable boolean Default is set to true

NotificationOption API

Property Type Default Description
avatar string | function null Can be render function
title string | function null Can be render function
description string | function null Can be render function
content string | function null Can be render function
meta string | function null Can be render function
action string | function null Can be render function
closable boolean true
onClose (next: function) => any next => next() Only if next is called notification will close
onAfterHide function null
onAfterShow function null
duration number null If not set, it won't automatically close

NotificationEnvironment API

NotificationEnvironment Properties

Properties of Instance of NofiticationEnvironment can be dynamically set.

Property Type Description
avatar string | function Can be render function
title string | function Can be render function
description string | function Can be render function
content string | function Can be render function
meta string | function Can be render function
action string | function Can be render function
closable boolean
onClose (next: function) => any Close mark is clicked. Only if next is called notification will close
onHide function
onAfterHide function
onAfterShow function

NotificationEnvironment Methods

Method Type Description
hide ()