https://github.com/kentico/xperience-events
Contains a custom module and page type for creating events and managing attendees in the Xperience interface.
https://github.com/kentico/xperience-events
event-calendar kentico-xperience
Last synced: about 1 year ago
JSON representation
Contains a custom module and page type for creating events and managing attendees in the Xperience interface.
- Host: GitHub
- URL: https://github.com/kentico/xperience-events
- Owner: Kentico
- License: mit
- Created: 2020-12-10T02:57:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-21T16:03:52.000Z (about 5 years ago)
- Last Synced: 2025-02-05T04:40:28.309Z (over 1 year ago)
- Topics: event-calendar, kentico-xperience
- Language: C#
- Homepage:
- Size: 131 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/Xperience.Events) 
# Xperience Events
## Installation
1. Install the [Xperience.Events](https://www.nuget.org/packages/Xperience.Events) NuGet package in the CMS application
1. _(Optional)_ Install the [companion package](https://github.com/kentico-ericd/xperience-core-events) in your .NET Core application
1. Build the CMS application
1. In the __Page types__ application, configure the [scopes](https://docs.xperience.io/developing-websites/defining-website-content-structure/managing-page-types/limiting-the-pages-users-can-create#Limitingthepagesuserscancreate-Managingpagetypescopes) and [allowed types](https://docs.xperience.io/developing-websites/defining-website-content-structure/managing-page-types/limiting-the-pages-users-can-create#Limitingthepagesuserscancreate-Allowinguserstoplacecertainpagesunderapagetype) for the new `Xperience.Event` and `Xperience.EventCalendar` page types
## Creating a calendar
To create a new calendar of events, create an `Xperience.EventCalendar` page in your content tree. The _Text color_, _Background color_, and _Bullet color_ fields determine how events of this calendar appear on the live site:
_Text color_ defaults to `#000`. Under the __Attendees__ section you can control which information appears in an event's detailed popup (if you installed the __Xperience.Core.Events__ NuGet package):
_Show event capacity and attendee count_ displays the "3 of 10" text from the above screenshot, and _Show event attendee names_ shows the list of names.
## Adding events to a calendar
To add events to a calendar, create `Xperience.Event` pages under the `Xperience.EventCalendar` page. Aside from basic information about the event, you can also configure registration for the event.
If _Requires registration_ is enabled, you can set an event capacity and also allow further registration if the capacity is exceeded. You can view and manage current registrations from the new __Attendees__ tab:
## Displaying events on the live site
If you installed the __Xperience.Core.Events__ package on your .NET Core site, you can [use the widget](https://github.com/kentico-ericd/xperience-core-events#displaying-event-calendars) to display calendars. Otherwise, you can use standard Xperience API to load calendars and their events: [Displaying page content](https://docs.xperience.io/developing-websites/retrieving-content/displaying-page-content).
```cs
var events = pageRetriever.Retrieve(query => query
.Path("/Calendars/Office", PathTypeEnum.Children));
```
## Compatibility
This code is only available for use on Kentico Xperience 13 websites. The CMS application must be hotfixed to _at least_ the version indicated at the top of the README.
## Feedback & Contributing
Check out the [contributing](https://github.com/kentico-ericd/xperience-core-events/blob/master/CONTRIBUTING.md) page to see the best places to file issues, start discussions, and begin contributing.
## License
The repository is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).