generated from Kentico/repo-template
-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Feat/documentation #2
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
2c33f0c
feat(docs): remove unwanted docs, add usage guide
bkapustik aef9a44
feat(docs): add contributing setup
bkapustik 4d63a96
fix(docs): images format
bkapustik 450ba28
fix(docs): remove images
bkapustik 877623a
fix(docs): remove redundancy
bkapustik 244603f
fix(docs): remove redundancy
bkapustik b781285
Add files via upload
bkapustik f4d9011
fix(docs): readme
bkapustik c7f6968
Update README.md
bkapustik 52c36c1
merge main
bkapustik c0edf40
fix(docs): grammar
bkapustik 4a5939c
fix(docs): grammar
bkapustik 53393dd
fix(formating): gitattributes end line rule
bkapustik f226dab
fix(docs): gitattributes
bkapustik 670b6f8
Merge branch 'main' into feat/documentation
bkapustik 543cab9
fix(docs): grammar
bkapustik 18dcdd4
Merge branch 'feat/documentation' of https://github.com/Kentico/xperi…
bkapustik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
* text eol=crlf | ||
*.png binary | ||
*.png binary |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Contributing Setup | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add missing full stops at the end of each step or bullet point. |
||
|
||
## Required Software | ||
|
||
The requirements to setup, develop, and build this project are listed below. | ||
|
||
### .NET Runtime | ||
|
||
.NET SDK 7.0 or newer | ||
|
||
- <https://dotnet.microsoft.com/en-us/download/dotnet/8.0> | ||
- See `global.json` file for specific SDK requirements. | ||
|
||
### Node.js Runtime | ||
|
||
- [Node.js](https://nodejs.org/en/download) 20.11.0 or newer. | ||
- [NVM for Windows](https://github.com/coreybutler/nvm-windows) to manage multiple installed versions of Node.js. | ||
- See `engines` in the solution `package.json` for specific version requirements. | ||
|
||
## Development environment setup | ||
|
||
1. Download/clone this repository. | ||
2. Run `npm run build` in the `/src/Kentico.Xperience.CalendarComponent/Client/`. | ||
3. Create an instance of [Kentico Xperience 13 administration](https://docs.kentico.com/13/installation/installing-xperience). | ||
4. [Create a database](https://docs.kentico.com/13/installation/additional-database-installation). | ||
5. Start the DancingGoatCore site. | ||
6. Open `WebApp.sln` of your administration project. | ||
7. Start the *CMSApp* project in IIS Express. | ||
8. Go to the *Forms* application. | ||
9. Edit a form. | ||
10. Open Form builder and add the Calendar form component. | ||
11. Configure the properties of the component. | ||
|
||
## Development Workflow | ||
|
||
1. Create a new branch with one of the following prefixes. | ||
|
||
- `feat/` - for new functionality. | ||
- `refactor/` - for restructuring of existing features. | ||
- `fix/` - for bugfixes. | ||
|
||
2. Run `dotnet format` against the `Kentico.Xperience.RepoTemplate` solution. | ||
|
||
> use `dotnet: format` VS Code task. | ||
|
||
3. Commit changes, with a commit message preferably following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) convention. | ||
|
||
4. Once ready, create a PR on GitHub. The PR will need to have all comments resolved and all tests passing before it will be merged. | ||
|
||
- The PR should have a helpful description of the scope of changes being contributed. | ||
- Include screenshots or video to reflect UX or UI updates. | ||
- Indicate if new settings need to be applied when the changes are merged - locally or in other environments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
# Configure a multi-value Calendar form component | ||
|
||
![Component](../images/calendar-component-multi-value.png) | ||
|
||
The following properties are configurable in the Kentico Form builder: | ||
1. Is Multi-Date Selection - Configures the calendar component to allow for range selection or multiple dates. | ||
|
||
2. Date Format - Configures the displayed date format. | ||
|
||
3. Excluded Date Time Data Provider - Here you can select the [Calendar dynamic data provider](./Dynamic-Calendar-Data-Provider.md). Note that setting the minimal/maximal time values in the provider is not relevant when using the multi-value calendar component. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Configure a single value Calendar form component | ||
|
||
![Component](../images/calendar-component-single-value.png) | ||
|
||
The following properties are configurable in the Kentico Form builder: | ||
|
||
![Form builder UI calendar form component configuration](../images/calendar-component-form-builder.png) | ||
|
||
1. Show Date Only - Configures the calendar component to use date or date and time format. | ||
|
||
2. Time Frame - Sets the number of minutes of each time interval selectable via the time setting arrows. | ||
|
||
3. Display in 24-Hour format - Configures whether time should be displayed in the 24-hour format or the 12-hour format with AM/PM. | ||
|
||
4. Date Format - Configures the displayed date format. | ||
|
||
5. Display time in client's time zone - Configures whether the value should be automatically shown in the client's time zone. If true, | ||
offset is added to the selected time according to user's time zone. | ||
Time is always saved in the server's time zone. | ||
Only Date Time uses the offset. Date only does not convert the time. | ||
|
||
6. Excluded Date Time Data Provider - Here you can select the [Calendar dynamic data provider](./Dynamic-Calendar-Data-Provider.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Usage Guide | ||
|
||
This library supports using a calendar component in Kentico Xperience 13 administration form builder. | ||
|
||
Below are the steps to integrate the library into your solution. | ||
|
||
## Single value calendar component | ||
|
||
See [Single value calendar component](Single-Value-Calendar-Component.md) to use the calendar as a single value configurable Date Time picker. | ||
|
||
## Multi-value calendar component | ||
|
||
See [Multi-value calendar component](Multi-Value-Calendar-Component.md) to use the calendar as a date picker of multiple values or range of dates. | ||
|
||
## Dynamic calendar data provider | ||
|
||
See [Dynamic calendar data provider](Dynamic-Calendar-Data-Provider.md) to set restrictions for allowed values. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add missing full stops at the end of each step.