Skip to content

Commit 20104b5

Browse files
committed
Add documentation comment
1 parent f005033 commit 20104b5

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

neptune.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,34 @@ export class Button {
123123
}
124124
}
125125

126+
/**
127+
* @class Link
128+
* @description Create a new Neptune Link
129+
*
130+
* @param {any} config Add your configuration
131+
*
132+
* parent -> class or id of your target element, when null its document.body
133+
*
134+
* text -> content of your Link
135+
*
136+
* size -> s, m, l
137+
*
138+
* style -> primary, cta, information, success, warning, error
139+
*
140+
* title -> add the title
141+
*
142+
* href -> add the href
143+
*
144+
* @example
145+
* const myLink = new Link({
146+
* parent: "#container",
147+
* text: "My Link",
148+
* size: "m",
149+
* style: "primary",
150+
* title: "My Link",
151+
* href: "https://de.wikipedia.org/"
152+
* });
153+
*/
126154
export class Link {
127155
constructor(config) {
128156
// Create Link

0 commit comments

Comments
 (0)