@berry-bundle-ui/assets
v0.0.3-alpha.1
Published
Blazor's BerryBundleUI Assets (CSS & JS)
Downloads
6
Maintainers
franzwcomReadme
Berry Bundle UI Assets (Alpha Version).
Important Notice:
Berry Bundle UI Assets (Alpha Version).
This documentation is for Berry Bundle UI Assets, a package currently in its alpha stage.
Alpha Software Warning:
Please be aware that Berry Bundle UI Assets is under active development and considered alpha software. This means it may contain:
Incomplete Features: Not all functionalities or components might be fully implemented. Bugs and Issues: You might encounter unexpected behavior or errors during use. API Changes: The package's API (application programming interface) could be subject to changes in future releases, potentially impacting your integration.
Not for Production Use:
Due to the alpha status, we strongly advise against using Berry Bundle UI Assets in production environments. It's intended for testing, prototyping, and early development purposes. Using it in production could lead to unexpected issues that might affect the stability and functionality of your application.
Consideration for Development and Testing:
If you choose to proceed with using Berry Bundle UI Assets for development or testing, please do so with caution and be prepared to handle potential issues. We recommend:
Thorough testing in a non-production environment. Implementing fallback mechanisms in case of unexpected behavior. Staying informed about updates and potential API changes. We appreciate your understanding and encourage you to explore Berry Bundle UI Assets for development and testing purposes. We're actively working on making it a production-ready solution in the future.
Installing the Package
Prerequisites:
Ensure you have Node.js and npm (or yarn) installed on your system. You can verify this by running node -v and npm -v (or yarn -v) in your terminal. If not installed, download them from the official Node.js website: https://nodejs.org/en Installation Command:
Open your terminal or command prompt and navigate to the root directory of your project where you want to use the @berry-bundle-ui/assets package. Then, run the following command:
Add using npm or yarn
npm i @berry-bundle-ui/assetsAlternatively, if you prefer using yarn, you can use
yarn add @berry-bundle-ui/assetsThis command will download the @berry-bundle-ui/assets package from the npm registry and install it in your project's node_modules directory.
Using the Package
Once the package is installed, you can import the desired CSS and JavaScript files into your project:
Importing CSS:
To include the CSS styles in your project, add the following line to your main stylesheet or a separate CSS file:
@import "@berry-bundle-ui/assets/dist/index.css";
This will import the CSS styles defined in the dist/index.css file of the package, providing you with the visual styles for your components.
2 JavaScript:
Once installed, you can directly link the JavaScript files in your HTML project:
Linking main.js and lib/index.js (Optional):
If you plan to use these JavaScript files directly in your project's HTML, you can add them using the tag:
<head>
<script src="node_modules/@berry-bundle-ui/assets/dist/main.js"></script>
<script src="node_modules/@berry-bundle-ui/assets/dist/lib/index.js"></script>
</head>Using @berry-bundle-ui/assets from a CDN in Blazor Apps
This documentation guides you on incorporating the @berry-bundle-ui/assets package's CSS styles into your Blazor application using a Content Delivery Network (CDN).
- Prerequisites:
A Blazor application project set up. Basic understanding of HTML and CSS integration in Blazor.
Using CDN Link in App.razor
Add the CDN Reference:
Open your App.razor file, which typically serves as the main layout component in Blazor applications. Inside the section of the file, add the following code:
it must match the version of the package you are using "0.0.1"
@{
var berryBundleCDN = "https://unpkg.com/@berry-bundle-ui/[email protected]/dist/main.min.css";
}
<link href="@berryBundleCDN" rel="stylesheet" />
Note:
** The above code snippet adds a link tag to the main.min.css file from the @berry-bundle-ui/assets package hosted on the unpkg CDN. Ensure that the version number in the CDN URL matches the version of the package you are using in your project. **