diff --git a/assets/styles/layout/_doc.scss b/assets/styles/layout/_doc.scss index ec6cf4360..683902249 100644 --- a/assets/styles/layout/_doc.scss +++ b/assets/styles/layout/_doc.scss @@ -1,3 +1,17 @@ +@mixin mark() { + border-radius: 6px; + padding: 2px 6px; + font-size: .875rem; + font-weight: 500; + font-style: normal; + background: var(--mark-background); + color: var(--mark-text); +} + +.mark { + @include mark(); +} + .doc-tabmenu { list-style: none; margin: 0; @@ -132,13 +146,7 @@ font-size: 1rem; i { - border-radius: 6px; - padding: 2px 6px; - font-size: .875rem; - font-weight: 500; - font-style: normal; - background: var(--mark-background); - color: var(--mark-text); + @include mark(); } a { diff --git a/doc/guides/migration/v4/NewFeaturesDoc.vue b/doc/guides/migration/v4/NewFeaturesDoc.vue deleted file mode 100644 index 75a8eaa80..000000000 --- a/doc/guides/migration/v4/NewFeaturesDoc.vue +++ /dev/null @@ -1,9 +0,0 @@ - diff --git a/doc/guides/migration/v4/OverviewDoc.vue b/doc/guides/migration/v4/OverviewDoc.vue index 14d0d2219..e0a02a799 100644 --- a/doc/guides/migration/v4/OverviewDoc.vue +++ b/doc/guides/migration/v4/OverviewDoc.vue @@ -2,8 +2,22 @@

At PrimeTek, we have been developing UI component libraries since 2008. The web continues to undergo technological advancements, and as a result, we have to modernize and update our libraries to stay relevant. PrimeVue v4 is the - next-generation version that fully embraces modern Web APIs and removes technical debt like the legacy-styled mode. As part of our commitment to our products and the community, PrimeVue v3 will continue to be maintained until the end of + next-generation version that fully embraces modern Web APIs and removes technical debt like the legacy-styled mode. Every component has been reviewed and enhanced. As part of our commitment to our products and the community, PrimeVue v3 will continue to be maintained until the end of 2024.

+

+ The most notable feature is the new styled mode implementation. Previous iterations use SASS at an external repo called primevue-sass-theme which requires compilation of a + theme.cssa file. This file had to be included in the application and need to be swapped at runtime for basic tasks like dark mode or primary color changes. In v4, styled mode is now part of the core, SASS is not used at all, and a + new design token based architecture that fully utilizes CSS variables has been created. The new API is modern and superior to the legacy styled mode. +

+

+ Names of some of the components have been changed to more common alternatives for example, Popover replaced OverlayPanel and InputSwitch is now called ToggleSwitch. Each component has been reviewed for a + consistent naming between CSS class names and PT sections. An example would be the option element of a Select component that uses p-select-option for the class name. +

+

+ Components have been utilized more within other components, for instance Dialog close button is not actually a PrimeVue button so that closeButtonProps can be used to enable the features of button like outlined, raised and more. + Whenever a component is using another component, in v3 the pt sections were causing confusion, to prevent this pc prefix is added to indicate that the PT section is actually a PrimeVue component, not a simple DOM element. This is + especially useful because PT allows passing arbitrary attributes to DOM elements whereas if the element is actually a PrimeVue component, props can also be passed. +

diff --git a/doc/guides/migration/v4/breakingchanges/ComponentsDoc.vue b/doc/guides/migration/v4/breakingchanges/ComponentsDoc.vue deleted file mode 100644 index 87f8aec7b..000000000 --- a/doc/guides/migration/v4/breakingchanges/ComponentsDoc.vue +++ /dev/null @@ -1,13 +0,0 @@ - diff --git a/doc/guides/migration/v4/breakingchanges/StyledModeDoc.vue b/doc/guides/migration/v4/breakingchanges/StyledModeDoc.vue deleted file mode 100644 index 1971a6dbb..000000000 --- a/doc/guides/migration/v4/breakingchanges/StyledModeDoc.vue +++ /dev/null @@ -1,14 +0,0 @@ - diff --git a/doc/guides/migration/v4/changes/BreakingDoc.vue b/doc/guides/migration/v4/changes/BreakingDoc.vue new file mode 100644 index 000000000..aeb706e6c --- /dev/null +++ b/doc/guides/migration/v4/changes/BreakingDoc.vue @@ -0,0 +1,39 @@ + diff --git a/doc/guides/migration/v4/changes/CompatibleDoc.vue b/doc/guides/migration/v4/changes/CompatibleDoc.vue new file mode 100644 index 000000000..2aa4c0dea --- /dev/null +++ b/doc/guides/migration/v4/changes/CompatibleDoc.vue @@ -0,0 +1,30 @@ + diff --git a/pages/guides/migration/v4/index.vue b/pages/guides/migration/v4/index.vue index 7adb35e82..2539cb995 100644 --- a/pages/guides/migration/v4/index.vue +++ b/pages/guides/migration/v4/index.vue @@ -6,7 +6,7 @@
-

Introduction

+

Migration

Migration guide to PrimeVue v4.

@@ -16,10 +16,9 @@