Download the PHP package lagdo/ui-builder without Composer
On this page you can find all versions of the php package lagdo/ui-builder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lagdo/ui-builder
More information about lagdo/ui-builder
Files in lagdo/ui-builder
Package ui-builder
Short Description A customizable and extensible HTML UI builder.
License MIT
Homepage https://github.com/lagdo/ui-builder
Informations about the package ui-builder
A customizable and extensible HTML UI builder
This package provides a unified API in PHP to create UI for CSS frameworks like Bootstrap.
It extends the PHP HTML builder with functions to create UI components like menus, forms, tabs and so on.
Motivation
This UI builder was first created for Jaxon DbAdmin, a database admin dashboard that can be inserted in a page of an existing PHP application. Its user interface then needs to adapt to various CSS frameworks, with as little effort as possible. So rewriting all the views for each supported CSS framework was not a satisfying option.
Using this UI buider, the UI of the app is written once, and the HTML code for CSS frameworks is generated automatically. Adding support of a given CSS framework is then easier and less error-prone.
Getting Started
The BuilderInterface
in the src/
directory defines the functions that can be used to build user interfaces, in addition to those provided by the PHP HTML builder.
While the later only generates HTML code, the BuilderInterface
functions will also add the CSS classes defined by the frameworks for the UI components.
The class that generates the final HTML code is provided by a separate package, which must be installed in addition to this one.
Prerequisites
This package requires PHP version 7.1 or greater.
Installation
Install the packages using Composer. In the examples below, we will build simple UI components for the Bootstrap framework.
Usage
The BuilderInterface
defines the functions that are use to build the UI components.
In this example, it is passed as parameter to the View
class constructor.
Depending on which class instance is passed to the View
constructor, a different HTML code will be generated.
With the following PHP code,
the getSimpleForm()
function will generate code for Bootstrap 3.
And with the following PHP code,
the same getSimpleForm()
function will generate code for Bootstrap 4.
Documentation
Coming soon...
Roadmap
- [ ] Add more components in the interface
- [ ] Add support of more UI frameworks
- [ ] Add tests
See the open issues for a full list of proposed features (and known issues).
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt
for more information.