Skip to content

Commit 0255bc9

Browse files
PiedonePiedone
authored
Merge pull request #77 from Lombiq/issue/OSOE-1087
OSOE-1087: Add documentation and NuGet metadata to the Widgets module in Lombiq.UIKit
2 parents a1e9b66 + c45be50 commit 0255bc9

File tree

10 files changed

+80
-14
lines changed

10 files changed

+80
-14
lines changed

‎Lombiq.UIKit.Tests.UI/Lombiq.UIKit.Tests.UI.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<Description>Lombiq UI Kit for Orchard Core - UI Test Extensions: Extensions to aid in UI testing Lombiq UI Kit for Orchard Core.</Description>
1212
<PackageIcon>NuGetIcon.png</PackageIcon>
1313
<PackageTags>OrchardCore;Lombiq;AspNetCore;UIKit</PackageTags>
14-
<RepositoryUrl>https://github.com/Lombiq/Orchard-Chart.js</RepositoryUrl>
14+
<RepositoryUrl>https://github.com/Lombiq/Orchard-UIKit</RepositoryUrl>
1515
<PackageProjectUrl>https://github.com/Lombiq/Orchard-UIKit/blob/dev/Lombiq.UIKit.Tests.UI/Readme.md</PackageProjectUrl>
1616
<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
1717
</PropertyGroup>

‎Lombiq.UIKit.Widgets.Tests.UI/Lombiq.UIKit.Widgets.Tests.UI.csproj‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,27 +5,25 @@
55
</PropertyGroup>
66

77
<PropertyGroup>
8-
<Title>Lombiq UI Kit Widgets for Orchard Core - UI Test Extensions</Title>
8+
<Title>Lombiq UI Kit - Widgets for Orchard Core - UI Test Extensions</Title>
99
<Authors>Lombiq Technologies</Authors>
1010
<Copyright>Copyright © 2022, Lombiq Technologies Ltd.</Copyright>
11-
<Description>Lombiq UI Kit Widgets for Orchard Core - UI Test Extensions: Extensions to aid in UI testing Lombiq UI Kit Widgets for Orchard Core.</Description>
11+
<Description>Lombiq UI Kit - Widgets for Orchard Core - UI Test Extensions: Extensions to aid in UI testing Lombiq UI Kit - Widgets for Orchard Core.</Description>
1212
<PackageIcon>NuGetIcon.png</PackageIcon>
1313
<PackageTags>OrchardCore;Lombiq;AspNetCore;UIKit;UIKit.Widgets</PackageTags>
1414
<RepositoryUrl>https://github.com/Lombiq/Orchard-UIKit</RepositoryUrl>
1515
<PackageProjectUrl>https://github.com/Lombiq/Orchard-UIKit/blob/dev/Lombiq.UIKit.Widgets.Tests.UI/Readme.md</PackageProjectUrl>
1616
<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
1717
</PropertyGroup>
1818

19-
<ItemGroup>
20-
<ProjectReference Include="..\Lombiq.UIKit.Widgets\Lombiq.UIKit.Widgets.csproj" />
21-
</ItemGroup>
22-
2319
<ItemGroup Condition="'$(NuGetBuild)' != 'true'">
2420
<ProjectReference Include="..\..\..\..\test\Lombiq.UITestingToolbox\Lombiq.Tests.UI\Lombiq.Tests.UI.csproj" />
21+
<ProjectReference Include="..\Lombiq.UIKit.Widgets\Lombiq.UIKit.Widgets.csproj" />
2522
</ItemGroup>
2623

2724
<ItemGroup Condition="'$(NuGetBuild)' == 'true'">
28-
<PackageReference Include="Lombiq.Tests.UI" Version="12.1.1-alpha.15.osoe-1064" />
25+
<PackageReference Include="Lombiq.Tests.UI" Version="12.1.1-alpha.32.osoe-1064" />
26+
<PackageReference Include="Lombiq.UIKit.Widgets" Version="9.0.1-alpha.2.osoe-1087" />
2927
</ItemGroup>
3028

3129
<ItemGroup>

‎Lombiq.UIKit.Widgets.Tests.UI/Readme.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Lombiq UI Kit Widgets for Orchard Core - UI Test Extensions
1+
# Lombiq UI Kit - Widgets for Orchard Core - UI Test Extensions
22

33
## About
44

‎Lombiq.UIKit.Widgets/Lombiq.UIKit.Widgets.csproj‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,27 @@
66
<Nullable>enable</Nullable>
77
<ImplicitUsings>enable</ImplicitUsings>
88
</PropertyGroup>
9+
10+
<PropertyGroup>
11+
<Title>Lombiq UI Kit - Widgets for Orchard Core</Title>
12+
<Authors>Lombiq Technologies</Authors>
13+
<Copyright>Copyright © 2024, Lombiq Technologies Ltd.</Copyright>
14+
<Description>Lombiq UI Kit - Widgets for Orchard Core: This module contains widgets based on shapes from Lombiq UI Kit. See the project website for detailed documentation.</Description>
15+
<PackageIcon>NuGetIcon.png</PackageIcon>
16+
<PackageTags>OrchardCore;Lombiq;AspNetCore;UI;UIKit;Widgets;front-end</PackageTags>
17+
<RepositoryUrl>https://github.com/Lombiq/Orchard-UIKit</RepositoryUrl>
18+
<PackageProjectUrl>https://github.com/Lombiq/Orchard-UIKit/blob/dev/Lombiq.UIKit.Widgets/Readme.md</PackageProjectUrl>
19+
<PackageLicenseExpression>BSD-3-Clause</PackageLicenseExpression>
20+
</PropertyGroup>
921

1022
<ItemGroup>
1123
<FrameworkReference Include="Microsoft.AspNetCore.App" />
1224
</ItemGroup>
1325

26+
<ItemGroup>
27+
<None Include="Readme.md" />
28+
<None Include="NuGetIcon.png" Pack="true" PackagePath="" />
29+
</ItemGroup>
1430

1531
<ItemGroup>
1632
<PackageReference Include="OrchardCore.Module.Targets" Version="2.1.0" />
@@ -21,8 +37,11 @@
2137
<PackageReference Include="OrchardCore.Media" Version="2.1.0" />
2238
</ItemGroup>
2339

24-
<ItemGroup>
25-
<ProjectReference Include="..\Lombiq.UIKit\Lombiq.UIKit.csproj" />
40+
<ItemGroup Condition="'$(NuGetBuild)' != 'true'">
41+
<ProjectReference Include="..\Lombiq.UIKit\Lombiq.UIKit.csproj" />
42+
</ItemGroup>
43+
<ItemGroup Condition="'$(NuGetBuild)' == 'true'">
44+
<PackageReference Include="Lombiq.UIKit" Version="9.0.0" />
2645
</ItemGroup>
2746

2847
</Project>

‎Lombiq.UIKit.Widgets/Manifest.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using OrchardCore.Modules.Manifest;
33

44
[assembly: Module(
5-
Name = "Lombiq UI Kit Widgets",
5+
Name = "Lombiq UI Kit - Widgets",
66
Author = "Lombiq Technologies",
77
Version = "0.0.1",
88
Description = "Module for reusable widgets based on Lombiq UI Kit.",

‎Lombiq.UIKit.Widgets/NuGetIcon.png‎

4.55 KB
Loading

‎Lombiq.UIKit.Widgets/Readme.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Lombiq UI Kit - Widgets for Orchard Core
2+
3+
[![Lombiq.UIKit Widgets NuGet](https://img.shields.io/nuget/v/Lombiq.UIKit?label=Lombiq.UIKit.Widgets)](https://www.nuget.org/packages/Lombiq.UIKit.Widgets/) [![Lombiq.UIKit.Tests.UI NuGet](https://img.shields.io/nuget/v/Lombiq.UIKit.Tests.UI?label=Lombiq.UIKit.Widgets.Tests.UI)](https://www.nuget.org/packages/Lombiq.UIKit.widgets.Tests.UI/)
4+
5+
## About
6+
7+
This module contains widgets that are based on the reusable shapes from [Lombiq UI Kit](../Lombiq.UIKit).
8+
9+
Available widgets:
10+
11+
- [Carousel Widget](#carousel-widget)
12+
13+
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!
14+
15+
## Documentation
16+
17+
Add this project to your solution. Then go to Admin panel and enable `Lombiq.UIKit.Widgets` by going to `Configuration` -> `Features`.
18+
19+
Once it's enabled you can use all widgets from this module just like any other widget.
20+
21+
### Carousel Widget
22+
23+
Based on UI Kit's [SlickCarousel](../Lombiq.UIKit/Views/SlickCarousel.cshtml) shape, this widget allows you to easily create carousels from the admin panel. The widget doesn't have any styles (except the default Slick style) but you can make ones that fit your site' needs without any overhead.
24+
25+
#### Configuration
26+
27+
To configure the global settings (for all carousels widgets) go to `Content`->`ContentDefinition`->`ContentTypes`. Find `CarouselWidget` content type and click on `Edit` button. There, under parts, edit `CarouselWidget` and on that page you can set [Slick slider options](https://kenwheeler.github.io/slick/#settings) using JSON.
28+
29+
#### Samples
30+
31+
To quickly see the carousel widget in action, go to `Configuration`->`Recipes` and find `Lombiq UI Kit - Widgets - Sample Content - Carousel Widget` recipe. This recipe will add a new page called `Carousel Widget Example` which will contain the carousel widget.
32+
33+
Please note that, like mentioned above, the carousel widget doesn't have any styles so you might need to make some CSS adjustments (depending on the theme).
34+
35+
## Contributing and support
36+
37+
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.
38+
39+
This project is developed by [Lombiq Technologies](https://lombiq.com/). Commercial-grade support is available through Lombiq.

‎Lombiq.UIKit.Widgets/Recipes/Lombiq.UIKit.Widgets.Content.recipe.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "Lombiq.UIKit.Widgets.Content",
3-
"displayName": "Lombiq UI Kit widgets - Sample Content - Carousel Widget",
4-
"description": "Sample content for testing and demonstration of the Lombiq UI kit Widgets module.",
3+
"displayName": "Lombiq UI Kit - Widgets - Sample Content - Carousel Widget",
4+
"description": "Sample content for testing and demonstration of the Lombiq UI Kit - Widgets module.",
55
"author": "Lombiq Technologies",
66
"website": "https://github.com/Lombiq/Orchard-UIKit",
77
"version": "1.0",

‎Lombiq.UIKit.sln‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Lombiq.UIKit.Tests.UI", "Lo
99
EndProject
1010
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lombiq.UIKit.Widgets", "Lombiq.UIKit.Widgets\Lombiq.UIKit.Widgets.csproj", "{D83FC55F-C3B7-43D6-BADE-DE376E66D4A3}"
1111
EndProject
12+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Lombiq.UIKit.Widgets.Tests.UI", "Lombiq.UIKit.Widgets.Tests.UI\Lombiq.UIKit.Widgets.Tests.UI.csproj", "{68ED40F9-2E50-0CEA-C322-8CE30FDFFD6B}"
13+
EndProject
1214
Global
1315
GlobalSection(SolutionConfigurationPlatforms) = preSolution
1416
Debug|Any CPU = Debug|Any CPU
@@ -27,6 +29,10 @@ Global
2729
{D83FC55F-C3B7-43D6-BADE-DE376E66D4A3}.Debug|Any CPU.Build.0 = Debug|Any CPU
2830
{D83FC55F-C3B7-43D6-BADE-DE376E66D4A3}.Release|Any CPU.ActiveCfg = Release|Any CPU
2931
{D83FC55F-C3B7-43D6-BADE-DE376E66D4A3}.Release|Any CPU.Build.0 = Release|Any CPU
32+
{68ED40F9-2E50-0CEA-C322-8CE30FDFFD6B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
33+
{68ED40F9-2E50-0CEA-C322-8CE30FDFFD6B}.Debug|Any CPU.Build.0 = Debug|Any CPU
34+
{68ED40F9-2E50-0CEA-C322-8CE30FDFFD6B}.Release|Any CPU.ActiveCfg = Release|Any CPU
35+
{68ED40F9-2E50-0CEA-C322-8CE30FDFFD6B}.Release|Any CPU.Build.0 = Release|Any CPU
3036
EndGlobalSection
3137
GlobalSection(SolutionProperties) = preSolution
3238
HideSolutionNode = FALSE

‎Readme.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ For your own styling you can override the default class stylings, or you can cre
2020

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

23+
## Lombiq UI Kit - Widgets
24+
25+
[Lombiq UI Kit - Widgets](Lombiq.UIKit.Widgets/) is a module that provides widgets based on the Lombiq UI Kit reusable shapes.
26+
2327
## Contributing and support
2428

2529
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.

0 commit comments

Comments
 (0)