Skip to content

docs(datetime): adds playground for styling calendar days using shadow parts #3101

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

Merged
merged 10 commits into from
Sep 6, 2023
21 changes: 16 additions & 5 deletions docs/api/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import HighlightedDatesCallback from '@site/static/usage/v7/datetime/highlighted
import MultipleDateSelection from '@site/static/usage/v7/datetime/multiple/index.md';

import GlobalTheming from '@site/static/usage/v7/datetime/styling/global-theming/index.md';
import CalendarDaysStyling from '@site/static/usage/v7/datetime/styling/calendar-days/index.md';
import WheelStyling from '@site/static/usage/v7/datetime/styling/wheel-styling/index.md';

<head>
Expand All @@ -50,7 +51,7 @@ import EncapsulationPill from '@components/page/api/EncapsulationPill';

Datetimes present a calendar interface and time wheel, making it easy for users to select dates and times. Datetimes are similar to the native `input` elements of `datetime-local`, however, Ionic Framework's Datetime component makes it easy to display the date and time in the preferred format, and manage the datetime values.

## Overview
## Overview

Historically, handling datetime values within JavaScript, or even within HTML
inputs, has always been a challenge. Specifically, JavaScript's `Date` object is
Expand Down Expand Up @@ -100,15 +101,15 @@ If you need to present a datetime in an overlay such as a modal or a popover, we

## Setting Values Asynchronously

If its `value` is updated programmatically after a datetime has already been created, the datetime will automatically jump to the new date. However, it is recommended to avoid updating the `value` in this way when users are able to interact with the datetime, as this could be disorienting for those currently trying to select a date. For example, if a datetime's `value` is loaded by an asyncronous process, it is recommended to hide the datetime with CSS until the value has finished updating.
If its `value` is updated programmatically after a datetime has already been created, the datetime will automatically jump to the new date. However, it is recommended to avoid updating the `value` in this way when users are able to interact with the datetime, as this could be disorienting for those currently trying to select a date. For example, if a datetime's `value` is loaded by an asynchronous process, it is recommended to hide the datetime with CSS until the value has finished updating.

## Date Constraints

### Max and Min Dates

To customize the minimum and maximum datetime values, the `min` and `max` component properties can be provided which may make more sense for the app's use-case. Following the same IS0 8601 format listed in the table above, each component can restrict which dates can be selected by the user.

The following example restricts date selection to March 2022 through May 2022 only.
The following example restricts date selection to March 2022 through May 2022 only.

<MaxMin />

Expand All @@ -122,7 +123,7 @@ The following example allows minutes to be selected in increments of 15. It also

### Advanced Date Constraints

With the `isDateEnabled` property, developers can customize the `ion-datetime` to disable a specific day, range of dates, weekends or any custom rule using an ISO 8601 date string.
With the `isDateEnabled` property, developers can customize the `ion-datetime` to disable a specific day, range of dates, weekends or any custom rule using an ISO 8601 date string.
The `isDateEnabled` property accepts a function returning a boolean, indicating if a date is enabled. The function is called for each rendered calendar day, for the previous, current and next month. Custom implementations should be optimized for performance to avoid jank.

The following example shows how to disable all weekend dates. For more advanced date manipulation, we recommend using a date utility such as `date-fns`.
Expand Down Expand Up @@ -325,6 +326,16 @@ The benefit of this approach is that every component, not just `ion-datetime`, c

<GlobalTheming />

### Calendar Days

The calendar days in the grid-style of an `ion-datetime` can be styled using CSS shadow parts.

:::note
The example below selects the day 2 days ago, unless that day is in the previous month, then it selects a day 2 days in the future. This is done for demo purposes in order to show how to apply custom styling to all days, the current day, and the selected day.
:::

<CalendarDaysStyling />

### Wheel Pickers

The wheels used in `ion-datetime` can be styled through a combination of shadow parts and CSS variables. This applies to both the columns in wheel-style datetimes, and the month/year picker in grid-style datetimes.
Expand Down Expand Up @@ -367,7 +378,7 @@ import { format, parseISO } from 'date-fns';
/**
* This is provided in the event
* payload from the `ionChange` event.
*
*
* The value is an ISO-8601 date string.
*/
const dateFromIonDatetime = '2021-06-04T14:23:00-04:00';
Expand Down
4 changes: 2 additions & 2 deletions static/code/stackblitz/v7/angular/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"dependencies": {
"@ionic/angular": "^7.0.0",
"@ionic/core": "^7.0.0"
"@ionic/angular": "7.3.1-dev.11692914300.171273b6",
"@ionic/core": "7.3.1-dev.11692914300.171273b6"
}
}
2 changes: 1 addition & 1 deletion static/code/stackblitz/v7/html/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"dependencies": {
"@ionic/core": "^7.0.0"
"@ionic/core": "7.3.1-dev.11692914300.171273b6"
}
}
4 changes: 2 additions & 2 deletions static/code/stackblitz/v7/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
"version": "0.1.0",
"private": true,
"dependencies": {
"@ionic/react": "^7.0.10",
"@ionic/react-router": "^7.0.10",
"@ionic/react": "7.3.1-dev.11692914300.171273b6",
"@ionic/react-router": "7.3.1-dev.11692914300.171273b6",
"@types/node": "^16.11.35",
"@types/react": "^18.0.9",
"@types/react-dom": "^18.0.4",
Expand Down
4 changes: 2 additions & 2 deletions static/code/stackblitz/v7/vue/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"preview": "vite preview"
},
"dependencies": {
"@ionic/vue": "^7.0.10",
"@ionic/vue-router": "^7.0.10",
"@ionic/vue": "7.3.1-dev.11692914300.171273b6",
"@ionic/vue-router": "7.3.1-dev.11692914300.171273b6",
"vue": "^3.2.25",
"vue-router": "4.0.13"
},
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
```css
/*
* Custom Datetime Day Parts
* -------------------------------------------
*/

ion-datetime::part(calendar-day) {
color: #da5296;

margin: 2px 0;
}

ion-datetime::part(calendar-day today) {
color: #8462d1;
}

/*
* Custom Material Design Datetime Day Parts
* -------------------------------------------
*/

ion-datetime.md::part(calendar-day):focus {
background-color: rgb(154 209 98 / 0.2);
box-shadow: 0px 0px 0px 4px rgb(154 209 98 / 0.2);
}

ion-datetime.md::part(calendar-day active),
ion-datetime.md::part(calendar-day active):focus {
background-color: #9ad162;
border-color: #9ad162;
color: #fff;
}

ion-datetime.md::part(calendar-day today) {
border-color: #8462d1;
}

/*
* Custom iOS Datetime Day Parts
* -------------------------------------------
*/

ion-datetime.ios::part(calendar-day):focus {
background-color: rgb(154 209 98 / 0.2);
}

ion-datetime.ios::part(calendar-day active),
ion-datetime.ios::part(calendar-day active):focus {
background-color: rgb(154 209 98 / 0.2);
color: #9ad162;
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```html
<ion-datetime presentation="date" [(ngModel)]="datetime"></ion-datetime>
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
```ts
import { Component, OnInit, ViewChild } from '@angular/core';

@Component({
selector: 'app-example',
templateUrl: 'example.component.html',
styleUrls: ['example.component.css'],
})
export class ExampleComponent implements OnInit {
public datetime;

ngOnInit() {
const date = new Date();

// Set the value of the datetime to 2 days
// before the current day
let dayChange = -2;

// If the day we are going to set the value to
// is in the previous month then set the day 2 days
// later instead so it remains in the same month
if (date.getDate() + dayChange <= 0) {
dayChange = -dayChange;
}

// Set the value of the datetime to the day
// calculated above
date.setDate(date.getDate() + dayChange);
this.datetime = date.toISOString().substr(0, 19);
}
}
```
97 changes: 97 additions & 0 deletions static/usage/v7/datetime/styling/calendar-days/demo.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Datetime</title>
<link rel="stylesheet" href="../../../../common.css" />
<script src="../../../../common.js"></script>
<script type="module" src="https://cdn.jsdelivr.net/npm/@ionic/core@7.3.1-dev.11692914300.171273b6/dist/ionic/ionic.esm.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@ionic/core@7.3.1-dev.11692914300.171273b6/css/ionic.bundle.css" />

<style>
/*
* Custom Datetime Day Parts
* -------------------------------------------
*/

ion-datetime::part(calendar-day) {
color: #da5296;

margin: 2px 0;
}

ion-datetime::part(calendar-day today) {
color: #8462d1;
}

/*
* Custom Material Design Datetime Day Parts
* -------------------------------------------
*/

ion-datetime.md::part(calendar-day):focus {
background-color: rgb(154 209 98 / 0.2);
box-shadow: 0px 0px 0px 4px rgb(154 209 98 / 0.2);
}

ion-datetime.md::part(calendar-day active),
ion-datetime.md::part(calendar-day active):focus {
background-color: #9ad162;
border-color: #9ad162;
color: #fff;
}

ion-datetime.md::part(calendar-day today) {
border-color: #8462d1;
}

/*
* Custom iOS Datetime Day Parts
* -------------------------------------------
*/

ion-datetime.ios::part(calendar-day):focus {
background-color: rgb(154 209 98 / 0.2);
}

ion-datetime.ios::part(calendar-day active),
ion-datetime.ios::part(calendar-day active):focus {
background-color: rgb(154 209 98 / 0.2);
color: #9ad162;
}
</style>
</head>

<body>
<ion-app>
<ion-content>
<div class="container">
<ion-datetime presentation="date"></ion-datetime>
</div>
</ion-content>
</ion-app>

<script>
const datetime = document.querySelector('ion-datetime');

const date = new Date();

// Set the value of the datetime to 2 days
// before the current day
let dayChange = -2;

// If the day we are going to set the value to
// is in the previous month then set the day 2 days
// later instead so it remains in the same month
if (date.getDate() + dayChange <= 0) {
dayChange = -dayChange;
}

// Set the value of the datetime to the day
// calculated above
date.setDate(date.getDate() + dayChange);
datetime.value = date.toISOString().substr(0, 19);
</script>
</body>
</html>
35 changes: 35 additions & 0 deletions static/usage/v7/datetime/styling/calendar-days/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import Playground from '@site/src/components/global/Playground';

import javascript from './javascript.md';

import react_main_tsx from './react/main_tsx.md';
import react_main_css from './react/main_css.md';

import vue from './vue.md';

import angular_example_component_html from './angular/example_component_html.md';
import angular_example_component_css from './angular/example_component_css.md';
import angular_example_component_ts from './angular/example_component_ts.md';

<Playground
version="7"
code={{
javascript,
react: {
files: {
'src/main.tsx': react_main_tsx,
'src/main.css': react_main_css,
},
},
vue,
angular: {
files: {
'src/app/example.component.html': angular_example_component_html,
'src/app/example.component.css': angular_example_component_css,
'src/app/example.component.ts': angular_example_component_ts,
},
},
}}
src="usage/v7/datetime/styling/calendar-days/demo.html"
size="medium"
/>
Loading