Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Init Puik v2 #331

Merged
merged 164 commits into from
May 28, 2024
Merged

Init Puik v2 #331

merged 164 commits into from
May 28, 2024

Conversation

mattgoud
Copy link
Collaborator

Puik v2 - Breaking Changes and Available Components

Breaking Changes

In the transition from Puik v1 to Puik v2, we made several significant changes to improve the library's performance, usability, and maintainability. Here are the key changes that you should be aware of:

  • Monorepo Structure: In Puik v2, we moved to a monorepo structure. This structure includes separate libraries for Vue 3 components, Web components, a component resolver for our Vue 3 component library, a CSS library containing all the classes used in our components, and a Tailwind CSS preset that contains all the design tokens used to create the components. This change was made to improve the modularity and maintainability of the project.

    ⚠️ Please note that this new structure may affect the import paths for the Puik library in your project. We recommend checking the README files for each package to understand the correct import paths.

  • Snackbar Component: In Puik v1, the Snackbar component was implemented using Headless UI. In Puik v2, we moved to using Radix Vue for the Snackbar component. This change was made to improve the component's accessibility and flexibility. If you're using the Snackbar component in your project, please refer to the Storybook documentation for details on how to adapt your code to this change.

  • Future Changes: Please note that all components that were implemented using Headless UI in Puik v1 may be moved to Radix Vue in future releases of Puik v2. We recommend regularly checking the Storybook documentation for the latest updates.

Please note that as Puik v2 is still in beta, additional breaking changes may be introduced as we continue to improve and expand the library. We recommend regularly checking this document and the Storybook documentation for the latest updates.

Available Components

Here is the list of available components in the Vue and Web-Components version of Puik v2.

Components Vue Components Web Components Breaking Changes
Accordion
Accordion-group
Alert
Avatar
Badge
Breadcrumb
Button
Button-group
Card
Checkbox
Chip
Divider
Icon
Input
Label
Link
Menu
Modal
Notification-bar
Pagination
Progress-bar
Progress-stepper
Progress-stepper-step
Radio
Select
Sidebar
Sidebar-group-item
Sidebar-item
Sidebar-title
Skeleton-loader
Skeleton-loader-group
Snackbar Previously implemented with Headless UI, now moved to Radix Vue (see Storybook documentation for more details)
Spinner-loader
Switch
Tab-navigation
Tab-navigation-group-panels
Tab-navigation-group-titles
Tab-navigation-panel
Tab-navigation-title
Table
Table-search-input
Tag
Textarea
Tooltip

aAmorim27 and others added 30 commits October 31, 2023 18:01
refactor: prefix all scss component file by puik

feat: handle fallback for useLocale, remove lodash functions

feat: clean unused utils
…pdated release workflow

feat: improved tsconfig file, tsc check for each packages
kevin-carangeot and others added 25 commits April 16, 2024 18:22
feat: [SPEX-1952][V2] Add link on Alert component
…web components), remove deprecated vscode extensions recommandations
…th-lockfile

ci: update pnpm version to try to fix the bug regarding the frozen-lo…
ci: create release workflow, rename beta-release workflow
@mattgoud mattgoud merged commit bcdbd24 into main May 28, 2024
3 of 5 checks passed
@mattgoud mattgoud deleted the feat/2.0.0-beta branch May 28, 2024 07:24
@mattgoud mattgoud restored the feat/2.0.0-beta branch June 21, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants