From 5323d888105bea2bec31fe9ee8e533b29e61414b Mon Sep 17 00:00:00 2001 From: Cagatay Civici Date: Wed, 2 Dec 2020 13:59:21 +0300 Subject: [PATCH] Documentation updates for the new components --- src/views/avatar/AvatarDoc.vue | 2 +- src/views/badge/BadgeDoc.vue | 35 +++++++++++++++++ src/views/confirmdialog/ConfirmDialogDoc.vue | 1 + src/views/confirmpopup/ConfirmPopupDoc.vue | 1 + src/views/divider/DividerDoc.vue | 1 + src/views/scrolltop/ScrollTopDoc.vue | 1 + src/views/tag/TagDoc.vue | 41 ++++++++++++++++++++ 7 files changed, 81 insertions(+), 1 deletion(-) diff --git a/src/views/avatar/AvatarDoc.vue b/src/views/avatar/AvatarDoc.vue index 2466fd87f..4eb420ece 100644 --- a/src/views/avatar/AvatarDoc.vue +++ b/src/views/avatar/AvatarDoc.vue @@ -115,7 +115,7 @@ import AvatarGroup from 'primevue/avatargroup'; -
Properties of AvatarGrouo
+
Properties of AvatarGroup

Any property as style and class are passed to the main container element. There are no additional properties.

Styling of Avatar
diff --git a/src/views/badge/BadgeDoc.vue b/src/views/badge/BadgeDoc.vue index 165837037..f2c76dbae 100644 --- a/src/views/badge/BadgeDoc.vue +++ b/src/views/badge/BadgeDoc.vue @@ -65,6 +65,41 @@ import Badge from 'primevue/badge'; +
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
valueanynullValue to display inside the badge.
severitystringnullSeverity type of the badge.
sizestringnullSize of the badge, valid options are "large" and "xlarge".
+
+
Styling

Following is the list of structural style classes, for theming classes visit theming page.

diff --git a/src/views/confirmdialog/ConfirmDialogDoc.vue b/src/views/confirmdialog/ConfirmDialogDoc.vue index 3ee441de0..cba341880 100644 --- a/src/views/confirmdialog/ConfirmDialogDoc.vue +++ b/src/views/confirmdialog/ConfirmDialogDoc.vue @@ -198,6 +198,7 @@ export default {
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

diff --git a/src/views/confirmpopup/ConfirmPopupDoc.vue b/src/views/confirmpopup/ConfirmPopupDoc.vue index a0f2f2069..e55fc3a31 100644 --- a/src/views/confirmpopup/ConfirmPopupDoc.vue +++ b/src/views/confirmpopup/ConfirmPopupDoc.vue @@ -183,6 +183,7 @@ export default {
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

diff --git a/src/views/divider/DividerDoc.vue b/src/views/divider/DividerDoc.vue index 932694445..d328fb5db 100644 --- a/src/views/divider/DividerDoc.vue +++ b/src/views/divider/DividerDoc.vue @@ -76,6 +76,7 @@ import Divider from 'primevue/divider';
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

diff --git a/src/views/scrolltop/ScrollTopDoc.vue b/src/views/scrolltop/ScrollTopDoc.vue index a1c2651b1..0d3a51609 100644 --- a/src/views/scrolltop/ScrollTopDoc.vue +++ b/src/views/scrolltop/ScrollTopDoc.vue @@ -38,6 +38,7 @@ import ScrollTop from 'primevue/scrolltop';
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

diff --git a/src/views/tag/TagDoc.vue b/src/views/tag/TagDoc.vue index d0c7f5d36..fa63d7ee7 100644 --- a/src/views/tag/TagDoc.vue +++ b/src/views/tag/TagDoc.vue @@ -45,6 +45,47 @@ import Tag from 'primevue/tag'; +
Properties
+

Any property as style and class are passed to the main container element. Following are the additional properties to configure the component.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefaultDescription
valueanynullValue to display inside the tag.
severitystringnullSeverity type of the tag.
roundedbooleanfalseWhether the corners of the tag are rounded.
iconstringnullIcon of the tag to display next to the value.
+
+
Styling

Following is the list of structural style classes, for theming classes visit theming page.