Skip to content

Commit

Permalink
feat(Notification): Add Notification component
Browse files Browse the repository at this point in the history
  • Loading branch information
@c0bra
c0bra authored Sep 9, 2019
1 parent d708ab3 commit c09227a
Show file tree
Hide file tree
Showing 13 changed files with 751 additions and 18 deletions.
309 changes: 308 additions & 1 deletion docs/src/routes/components/jsdocs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1002,6 +1002,313 @@
"Modal": [],
"Notice": [],
"Notices": [],
"Notification": [
{
"meta": {
"filename": "Notification.svelte",
"lineno": 9,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Type (color)",
"type": [
"String"
],
"optional": true,
"name": "type",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String"
]
},
"optional": true,
"name": "type"
},
"kind": "prop",
"values": "<code>is-white</code>, <code>is-black</code>, <code>is-light</code>, <code>is-dark</code>, <code>is-primary</code>, <code>is-info</code>, <code>is-success</code>, <code>is-warning</code>, <code>is-danger</code>",
"longname": "module:Notification~type",
"scope": "inner",
"memberof": "module:Notification",
"___s": true
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 15,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Whether the notification is visible or not",
"type": [
"boolean"
],
"defaultvalue": true,
"name": "active",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"boolean"
]
},
"defaultvalue": true,
"name": "active"
},
"kind": "prop",
"longname": "module:Notification~active",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 20,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Display an X button that closes the notification",
"type": [
"boolean"
],
"defaultvalue": true,
"name": "showClose",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"boolean"
]
},
"defaultvalue": true,
"name": "showClose"
},
"kind": "prop",
"longname": "module:Notification~showClose",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 25,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Automatically close the notification after <code>duration</code>. Doesn't apply when opening programmatically",
"type": [
"boolean"
],
"defaultvalue": false,
"name": "autoClose",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"boolean"
]
},
"defaultvalue": false,
"name": "autoClose"
},
"kind": "prop",
"longname": "module:Notification~autoClose",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 30,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Duration notification will remain on screen",
"type": [
"Number"
],
"optional": true,
"defaultvalue": 2000,
"name": "duration",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"Number"
]
},
"optional": true,
"defaultvalue": 2000,
"name": "duration"
},
"kind": "prop",
"longname": "module:Notification~duration",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 35,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Show icon on left-side of the notification. If set to <code>true</code>, icon will be determined from <code>type</code> property.",
"type": [
"String",
"Boolean"
],
"optional": true,
"name": "icon",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String",
"Boolean"
]
},
"optional": true,
"name": "icon"
},
"kind": "prop",
"longname": "module:Notification~icon",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 40,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Fontawesome icon pack to use. By default the <code>Icon</code> component uses <code>fas</code>",
"type": [
"String"
],
"optional": true,
"name": "iconPack",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String"
]
},
"optional": true,
"name": "iconPack"
},
"kind": "prop",
"values": "<code><code>fas</code></code>, <code><code>fab</code></code>, <code>etc...</code>",
"longname": "module:Notification~iconPack",
"scope": "inner",
"memberof": "module:Notification",
"___s": true
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 46,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Label for the close button, to be read by accessibility screenreaders",
"type": [
"String"
],
"optional": true,
"name": "ariaCloseLabel",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String"
]
},
"optional": true,
"name": "ariaCloseLabel"
},
"kind": "prop",
"longname": "module:Notification~ariaCloseLabel",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 51,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Text for notification, when used programmatically",
"type": [
"String"
],
"name": "message",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String"
]
},
"name": "message"
},
"kind": "prop",
"longname": "module:Notification~message",
"scope": "inner",
"memberof": "module:Notification",
"___s": true,
"values": ""
},
{
"meta": {
"filename": "Notification.svelte",
"lineno": 55,
"columnno": 2,
"path": "src/components/Notification"
},
"description": "Where the notification will show on the screen when used programmatically",
"type": [
"String"
],
"optional": true,
"defaultvalue": "is-top-right",
"name": "position",
"_isSvelteDoc": true,
"_svelteProps": {
"type": {
"names": [
"String"
]
},
"optional": true,
"defaultvalue": "is-top-right",
"name": "position"
},
"kind": "prop",
"values": "<code><code>is-top</code></code>, <code><code>is-bottom</code></code>, <code><code>is-top-left</code></code>, <code><code>is-top-right</code></code>, <code><code>is-bottom-left</code></code>, <code><code>is-bottom-right</code></code>",
"longname": "module:Notification~position",
"scope": "inner",
"memberof": "module:Notification",
"___s": true
}
],
"NotificationNotice": [],
"Progress": [
{
"meta": {
Expand Down Expand Up @@ -1475,7 +1782,7 @@
"columnno": 2,
"path": "src/components/Tabs"
},
"description": "Show this icon on left-side of the tab.",
"description": "Show this icon on left-side of the tab",
"type": [
"String"
],
Expand Down
Loading

0 comments on commit c09227a

Please sign in to comment.