Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ui-awesome/html-core-component
UI Awesome HTML Core Component for PHP.
https://github.com/ui-awesome/html-core-component
List: html-core-component
html html-core-component php ui-awesome
Last synced: about 2 months ago
JSON representation
UI Awesome HTML Core Component for PHP.
- Host: GitHub
- URL: https://github.com/ui-awesome/html-core-component
- Owner: ui-awesome
- License: mit
- Created: 2024-03-23T10:56:23.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-31T13:30:49.000Z (9 months ago)
- Last Synced: 2024-10-10T03:47:55.099Z (2 months ago)
- Topics: html, html-core-component, php, ui-awesome
- Language: PHP
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
UI Awesome HTML Core Component for PHP.
These abstract classes serve as foundational building blocks for creating diverse UI components in HTML applications.
They provide a structured approach to developing reusable components with customizable configurations and default
settings.
By extending these classes, you can quickly implement and customize various UI elements, such as breadcrumbs,
dropdowns, navigation bars, and toggles, to enhance your application's user interface.
- AbstractBreadcrumb: Extend this class to implement breadcrumb navigation components. It simplifies the management of
breadcrumb items and offers customizable configurations for rendering breadcrumb elements.
- AbstractDropdown: Extend this class to effortlessly implement dropdown components. It simplifies the management of
menu items and offers customizable configurations for rendering dropdown elements.
- AbstractNavBar: Use this class as a basis for crafting navigation bar components. It provides flexibility in rendering
brand elements, menus, and additional content, with customizable attributes and default configurations.
- AbstractToggle: Extend this class to create toggle components with ease. It supports various types (e.g., button, link)
and offers functionality for rendering toggle elements using customizable templates, attributes, and content.
- Item: This class represents individual items within a menu or breadcrumb. It allows for easy management of item attributes
and content.
- Menu: This class represents a collection of menu items. It facilitates the organization and rendering of menu items within
dropdowns, navigation bars, or other menu-based components.
Simply extend these abstract classes and apply their default configurations to swiftly integrate and customize UI components
tailored to your application's requirements.
## Installation
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
Either run
```shell
composer require --prefer-dist ui-awesome/html-core-component:^0.1
```
or add
```json
"ui-awesome/html-core-component": "^0.1"
```
to the require-dev section of your `composer.json` file.
## Usage
To use the classes in your project, you need to extend them in your custom components.
For example, to create a custom breadcrumb component, you can extend the `AbstractBreadcrumb` class:
```php
use UIAwesome\Html\Core\Component\AbstractBreadcrumb;
class CustomBreadcrumb extends AbstractBreadcrumb
{
// Custom implementation
}
```
## Testing
[Check the documentation testing](docs/testing.md) to learn about testing.
## Support versions
[](https://www.php.net/releases/8.1/en.php)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.
## Our social networks
[](https://twitter.com/Terabytesoftw)