quasar-app-extension-internal-ui-library v1.0.8
Internal UI Library
The Internal UI Library extension serves as a comprehensive toolkit for creating shared components and managing common functionalities within the new internal frontend apps generated from the Internal FE Boilerplate. It encompasses the management of common services, types, utility functions, enums, composables, and mocks. Additionally, it allows the creation of common boot files, enabling code execution before the root Vue app instance is instantiated (for instance, injection functionalities, refer to src/boot/sentry for implementation details).
Installation
yarn add --dev git+https://2a5983e8f8fd3becfbf3d48d1af71eb87999b5e7@github.com/hellochef-me/internal-ui-library.git
quasar ext invoke internal-ui-libraryThe Quasar CLI retrieves the extension and installs it seamlessly.
Upgrade
yarn upgrade quasar-app-extension-internal-ui-library
quasar ext invoke internal-ui-libraryUninstall
quasar ext uninvoke internal-ui-library
yarn remove quasar-app-extension-internal-ui-libraryRelease
Ensure compliance with semver guidelines. After switching to the main branch and fetching remote changes, execute one of the following commands:
yarn version --majoryarn version --minoryarn version --patch
Release Beta or RC
To publish a beta or release candidate version, utilize the following commands:
yarn version --prerelease- Pre Release (e.g., 0.0.2-1)yarn version --prerelease --preid rc- Release Candidate Pre Release (e.g., 0.0.1-rc.1)yarn version --prerelease --preid beta- Beta Pre Release (e.g., 0.0.1-beta.1)
Additional Information
The src folder contains the Quasar extension. Leveraging Quasar as the framework for our internal frontend apps, we employ the Quasar App Extension to generate custom/shared components. This extension allows customization of existing Quasar components (e.g., HcBtn or HcTable) or creation of new custom components (e.g., DisclosureCard).
To create a component, navigate to src/components/ and create the desired component. Import and export the component in src/plugin/vue-plugin.js, and describe its type in types/Components.ts. Please refer to existing components for guidance. For overriding existing Quasar components, we recommend prefixing with 'Hc' (e.g., HcBtn, HcTable) to distinguish from standard Quasar components.
The library supports the addition of generic types, services, composables, enums, mocks, utilities, etc., all located in the root folder.
Happy coding! 🥳.
Components
2 months ago