Skip to content

Commit

Permalink
docs: update github hosting url
Browse files Browse the repository at this point in the history
Fixes #1675
  • Loading branch information
mattlewis92 committed Aug 18, 2023
1 parent c24bf4d commit 663bb5d
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 15 deletions.
9 changes: 4 additions & 5 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,18 @@ about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

<!---
FAQ (please read!):
Need an example of how to do something? Check the demo page, it probably has you covered: https://mattlewis92.github.io/angular-calendar/demos/
Need an example of how to do something? Check the demo page, it probably has you covered: https://mattlewis-github.com/angular-calendar/demos/
Need a full list of all API options? Check the docs for each component:
https://mattlewis92.github.io/angular-calendar/docs/components/CalendarMonthViewComponent.html
https://mattlewis92.github.io/angular-calendar/docs/components/CalendarWeekViewComponent.html
https://mattlewis92.github.io/angular-calendar/docs/components/CalendarDayViewComponent.html
https://mattlewis-github.com/angular-calendar/docs/components/CalendarMonthViewComponent.html
https://mattlewis-github.com/angular-calendar/docs/components/CalendarWeekViewComponent.html
https://mattlewis-github.com/angular-calendar/docs/components/CalendarDayViewComponent.html
Please note that issues that ignore this template will be closed without notice!
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -323,7 +323,7 @@ The `getDayView` and `getDayViewHourGrid` functions have been removed from the `

The following interfaces from `calendar-utils` were renamed: `DayViewHourSegment` -> `WeekViewHourSegment`, `DayViewHour` -> `WeekViewHour`, `DayViewEvent` -> `WeekViewTimeEvent`

The day view scheduler demo is now based off the week view instead, please check the updated demo code for how to migrate: https://mattlewis92.github.io/angular-calendar/#/day-view-scheduler
The day view scheduler demo is now based off the week view instead, please check the updated demo code for how to migrate: https://mattlewis-github.com/angular-calendar/#/day-view-scheduler

If using a custom template for the `hourSegmentTemplate`, you must pass `let-isTimeLabel="isTimeLabel"` as a local variable and then change `<div class="cal-time">` to `<div class="cal-time" *ngIf="isTimeLabel">`
* the dist files are no longer annotated for usage with closure compiler.
Expand Down Expand Up @@ -1257,7 +1257,7 @@ People using custom day event event templates can also remove these lines from t
### BREAKING CHANGES

* **monthView:** the `dayModifier` input has been replaced with a more powerful `beforeViewRender`
output. See [the demo](https://mattlewis92.github.io/angular-calendar/#/before-view-render) for an example of how to migrate your code.
output. See [the demo](https://mattlewis-github.com/angular-calendar/#/before-view-render) for an example of how to migrate your code.
* **dayView:** the `hourSegmentModifier` has been replaced with the `beforeViewRender` output.
* For system.js users only, the UMD path to the `calendar-utils` module has changed from `calendar-utils/dist/umd/calendarUtils.js` to `calendar-utils/dist/umd/calendar-utils.js`
* **weekView:** the `allowDragOutside` option has been removed from the week view as this can be implemented in user land. Please see this plunker for how to introduce it yourself: http://plnkr.co/edit/5KyUBC0lnfMsYMcVFAR9?p=preview
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

<div align="center">

https://mattlewis92.github.io/angular-calendar/
https://mattlewis-github.com/angular-calendar/

</div>

Expand Down Expand Up @@ -85,15 +85,15 @@ import { adapterFactory } from 'angular-calendar/date-adapters/date-fns';
export class MyModule {}
```

In order to allow the most flexibility for all users there is a substantial amount of boilerplate required to get up and running. Please see the [demos list](https://mattlewis92.github.io/angular-calendar/) for a series of comprehensive examples of how to use this library within your application.
In order to allow the most flexibility for all users there is a substantial amount of boilerplate required to get up and running. Please see the [demos list](https://mattlewis-github.com/angular-calendar/) for a series of comprehensive examples of how to use this library within your application.

Once you are up and running, to access a full list of options for each component, the individual APIs are documented here: [`mwl-calendar-month-view`](https://mattlewis92.github.io/angular-calendar/docs/components/CalendarMonthViewComponent.html), [`mwl-calendar-week-view`](https://mattlewis92.github.io/angular-calendar/docs/components/CalendarWeekViewComponent.html) and [`mwl-calendar-day-view`](https://mattlewis92.github.io/angular-calendar/docs/components/CalendarDayViewComponent.html).
Once you are up and running, to access a full list of options for each component, the individual APIs are documented here: [`mwl-calendar-month-view`](https://mattlewis-github.com/angular-calendar/docs/components/CalendarMonthViewComponent.html), [`mwl-calendar-week-view`](https://mattlewis-github.com/angular-calendar/docs/components/CalendarWeekViewComponent.html) and [`mwl-calendar-day-view`](https://mattlewis-github.com/angular-calendar/docs/components/CalendarDayViewComponent.html).

> Please note: angular-calendar uses [Scarf](https://scarf.sh/) to collect anonymized installation analytics. These analytics help support the maintainers of this library. However, if you'd like to opt out, you can do so by setting `scarfSettings.enabled = false` in your project's package.json. Alternatively, you can set the environment variable `SCARF_ANALYTICS=false` before you install.
<h2 align="center">Documentation</h2>

To see all available API options, take a look at the auto generated [documentation](https://mattlewis92.github.io/angular-calendar/docs/). You may find it helpful to view the examples on the demo page.
To see all available API options, take a look at the auto generated [documentation](https://mattlewis-github.com/angular-calendar/docs/). You may find it helpful to view the examples on the demo page.

<h2 align="center">Breaking changes</h2>

Expand Down Expand Up @@ -135,17 +135,17 @@ As there are so many events to show on each month, it doesn’t provide a lot of

### Does this calendar work with mobile?

This library is not optimised for mobile. Due to the complex nature of a calendar component, it is non trivial to build a calendar that has a great UX on both desktop and mobile. It is recommended to build your own calendar component for mobile that has a dedicated UX. You may be able to get some degree of mobile support by setting some custom CSS rules for smaller screens on the month view and showing less days on the [week view](https://mattlewis92.github.io/angular-calendar/#/responsive-week-view).
This library is not optimised for mobile. Due to the complex nature of a calendar component, it is non trivial to build a calendar that has a great UX on both desktop and mobile. It is recommended to build your own calendar component for mobile that has a dedicated UX. You may be able to get some degree of mobile support by setting some custom CSS rules for smaller screens on the month view and showing less days on the [week view](https://mattlewis-github.com/angular-calendar/#/responsive-week-view).

### How do I use a custom template?

All parts of this calendar can be customised via the use of an `ng-template`. The recipe for applying one is as follows:

- Find the template you would like to customise for the month, week or day view component. You can find all available custom templates by reading the [documentation](https://mattlewis92.github.io/angular-calendar/docs/) for each component. For this example we will pick the [`cellTemplate`](https://mattlewis92.github.io/angular-calendar/docs/components/CalendarMonthViewComponent.html#cellTemplate) from the month view.
- Find the template you would like to customise for the month, week or day view component. You can find all available custom templates by reading the [documentation](https://mattlewis-github.com/angular-calendar/docs/) for each component. For this example we will pick the [`cellTemplate`](https://mattlewis-github.com/angular-calendar/docs/components/CalendarMonthViewComponent.html#cellTemplate) from the month view.
- Next find the corresponding child component that will render the template by viewing the source. For our example of the month view cell it is [this component](https://github.com/mattlewis92/angular-calendar/blob/main/projects/angular-calendar/src/modules/month/calendar-month-view/calendar-month-cell/calendar-month-cell.component.ts)
- Now copy the [template source](https://github.com/mattlewis92/angular-calendar/blob/be842da460a803ebb570418bc10e11fab56bd7b9/projects/angular-calendar/src/modules/month/calendar-month-cell.component.ts#L15-L72) for your chosen template into your own component and modify as your see fit.
- Finally pass the template to the components input: `<mwl-calendar-month-view [cellTemplate]="cellTemplateId" />`
- You can see an e2e working example of this [here](https://mattlewis92.github.io/angular-calendar/#/custom-templates)
- You can see an e2e working example of this [here](https://mattlewis-github.com/angular-calendar/#/custom-templates)

### What is the browser compatibility?

Expand Down
2 changes: 1 addition & 1 deletion projects/demos/app/demo-app.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<li class="nav-item">
<a
class="nav-link"
href="https://mattlewis92.github.io/angular-calendar/docs/"
href="https://mattlewis-github.com/angular-calendar/docs/"
>
<i class="fas fa-book"></i> API docs
</a>
Expand Down

0 comments on commit 663bb5d

Please sign in to comment.