https://github.com/lombiq/orchard-uikit

Orchard Core module with reusable UI elements.
https://github.com/lombiq/orchard-uikit

bootstrap bootstrap5 orchard orchard-cms orchard-core orchard-module ui-kit

Last synced: 18 days ago
JSON representation

Orchard Core module with reusable UI elements.

• Host: GitHub
• URL: https://github.com/lombiq/orchard-uikit
• Owner: Lombiq
• License: bsd-3-clause
• Created: 2021-03-29T12:15:59.000Z (over 3 years ago)
• Default Branch: dev
• Last Pushed: 2024-11-28T02:06:38.000Z (24 days ago)
• Last Synced: 2024-11-30T04:40:01.685Z (22 days ago)
• Topics: bootstrap, bootstrap5, orchard, orchard-cms, orchard-core, orchard-module, ui-kit
• Language: HTML
• Homepage:
• Size: 324 KB
• Stars: 5
• Watchers: 9
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md
  • License: License.md

Awesome Lists containing this project

README

        
# Lombiq UI Kit for Orchard Core

[![Lombiq.UIKit NuGet](https://img.shields.io/nuget/v/Lombiq.UIKit?label=Lombiq.UIKit)](https://www.nuget.org/packages/Lombiq.UIKit/) [![Lombiq.UIKit.Tests.UI NuGet](https://img.shields.io/nuget/v/Lombiq.UIKit.Tests.UI?label=Lombiq.UIKit.Tests.UI)](https://www.nuget.org/packages/Lombiq.UIKit.Tests.UI/)

## About

This module contains reusable shapes like text editors, custom-style checkboxes, dropdown editors, and in the future potentially more complex editors. [Here](https://www.youtube.com/watch?v=PONfn2K8AHg) you can also see a demo of it.

Do you want to quickly try out this project and see it in action? Check it out in our [Open-Source Orchard Core Extensions](https://github.com/Lombiq/Open-Source-Orchard-Core-Extensions) full Orchard Core solution and also see our other useful Orchard Core-related open-source projects!

## Documentation

Add the module to your solution and enable the `Lombiq UI Kit - Showcase page` feature if you want to check out the currently available shapes. Be sure that the dependencies can be found in the directory specified in the [Project file](Lombiq.UIKit/Lombiq.UIKit.csproj), or modify them where they are located in your solution. You can see them under `~/UIKitShowcase` after the feature is enabled. The example code for using these shapes can be seen in _[Views/Showcase/Showcase.cshtml](Lombiq.UIKit/Views/Showcase/Showcase.cshtml)_. This module contains only those stylings which are needed for these shapes to work.

To see documentation on the Bootstrap controls, see [Docs/BootstrapControls.md](Lombiq.UIKit/Docs/BootstrapControls.md).

### Custom class and id

For your own styling you can override the default class stylings, or you can create a new class and add it to the shape block via the `BlockClassName` parameter.

If it is needed to add an Id for the container block, then you can do that with the `BlockId` parameter.

## Contributing and support

Bug reports, feature requests, comments, questions, code contributions and love letters are warmly welcome. You can send them to us via GitHub issues and pull requests. Please adhere to our [open-source guidelines](https://lombiq.com/open-source-guidelines) while doing so.

This project is developed by [Lombiq Technologies](https://lombiq.com/). Commercial-grade support is available through Lombiq.