Skip to content
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

Date: Add timezone hint #23400

Merged
merged 10 commits into from
Jul 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions lib/compat.php
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,77 @@ function gutenberg_add_dom_rect_polyfill( $scripts ) {
}
add_action( 'wp_default_scripts', 'gutenberg_add_dom_rect_polyfill', 20 );

/**
* Adds a wp.date.setSettings with timezone abbr parameter
*
* This can be removed when plugin support requires WordPress 5.6.0+.
*
* The script registration occurs in core wp-includes/script-loader.php
* wp_default_packages_inline_scripts()
*
* @since 8.6.0
*
* @param WP_Scripts $scripts WP_Scripts object.
*/
function gutenberg_add_date_settings_timezone( $scripts ) {
if ( ! did_action( 'init' ) ) {
return;
}

global $wp_locale;

// Calculate the timezone abbr (EDT, PST) if possible.
$timezone_string = get_option( 'timezone_string', 'UTC' );
$timezone_abbr = '';

if ( ! empty( $timezone_string ) ) {
$timezone_date = new DateTime( null, new DateTimeZone( $timezone_string ) );
$timezone_abbr = $timezone_date->format( 'T' );
}

$scripts->add_inline_script(
'wp-date',
sprintf(
'wp.date.setSettings( %s );',
wp_json_encode(
array(
'l10n' => array(
'locale' => get_user_locale(),
'months' => array_values( $wp_locale->month ),
'monthsShort' => array_values( $wp_locale->month_abbrev ),
'weekdays' => array_values( $wp_locale->weekday ),
'weekdaysShort' => array_values( $wp_locale->weekday_abbrev ),
'meridiem' => (object) $wp_locale->meridiem,
'relative' => array(
/* translators: %s: Duration. */
'future' => __( '%s from now', 'default' ),
/* translators: %s: Duration. */
'past' => __( '%s ago', 'default' ),
),
),
'formats' => array(
/* translators: Time format, see https://www.php.net/date */
'time' => get_option( 'time_format', __( 'g:i a', 'default' ) ),
/* translators: Date format, see https://www.php.net/date */
'date' => get_option( 'date_format', __( 'F j, Y', 'default' ) ),
/* translators: Date/Time format, see https://www.php.net/date */
'datetime' => __( 'F j, Y g:i a', 'default' ),
/* translators: Abbreviated date/time format, see https://www.php.net/date */
'datetimeAbbreviated' => __( 'M j, Y g:i a', 'default' ),
),
'timezone' => array(
'offset' => get_option( 'gmt_offset', 0 ),
'string' => $timezone_string,
'abbr' => $timezone_abbr,
),
)
)
),
'after'
);
}
add_action( 'wp_default_scripts', 'gutenberg_add_date_settings_timezone', 20 );

/**
* Filters default block categories to substitute legacy category names with new
* block categories.
Expand Down
1 change: 1 addition & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"@emotion/styled": "^10.0.23",
"@wordpress/a11y": "file:../a11y",
"@wordpress/compose": "file:../compose",
"@wordpress/date": "file:../date",
"@wordpress/deprecated": "file:../deprecated",
"@wordpress/dom": "file:../dom",
"@wordpress/element": "file:../element",
Expand Down
7 changes: 7 additions & 0 deletions packages/components/src/date-time/style.scss
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,13 @@
}
}

.components-datetime__timezone {
color: $dark-gray-500;
line-height: 30px;
margin-left: $grid-unit-05;
text-decoration: underline dotted;
}

.components-datetime__time-legend {
font-weight: 600;
margin-top: 0.5em;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ exports[`TimePicker matches the snapshot when the is12hour prop is false 1`] = `
value="00"
/>
</div>
<TimeZone />
</div>
</fieldset>
</div>
Expand Down Expand Up @@ -337,6 +338,7 @@ exports[`TimePicker matches the snapshot when the is12hour prop is specified 1`]
PM
</ForwardRef(Button)>
</ForwardRef(ButtonGroup)>
<TimeZone />
</div>
</fieldset>
</div>
Expand Down Expand Up @@ -518,6 +520,7 @@ exports[`TimePicker matches the snapshot when the is12hour prop is true 1`] = `
PM
</ForwardRef(Button)>
</ForwardRef(ButtonGroup)>
<TimeZone />
</div>
</fieldset>
</div>
Expand Down Expand Up @@ -679,6 +682,7 @@ exports[`TimePicker matches the snapshot when the is12hour prop is undefined 1`]
value="00"
/>
</div>
<TimeZone />
</div>
</fieldset>
</div>
Expand Down
4 changes: 4 additions & 0 deletions packages/components/src/date-time/time.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import { __ } from '@wordpress/i18n';
*/
import Button from '../button';
import ButtonGroup from '../button-group';
import TimeZone from './timezone';

/**
* Module Constants
Expand Down Expand Up @@ -277,6 +278,7 @@ class TimePicker extends Component {
render() {
const { is12Hour } = this.props;
const { year, minutes, hours, am } = this.state;

return (
<div className={ classnames( 'components-datetime__time' ) }>
<fieldset>
Expand Down Expand Up @@ -353,6 +355,8 @@ class TimePicker extends Component {
</Button>
</ButtonGroup>
) }

<TimeZone />
</div>
</fieldset>
</div>
Expand Down
45 changes: 45 additions & 0 deletions packages/components/src/date-time/timezone.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* WordPress dependencies
*/
import { __ } from '@wordpress/i18n';
import { __experimentalGetSettings as getDateSettings } from '@wordpress/date';

/**
* Internal dependencies
*/
import Tooltip from '../tooltip';

/**
* Displays timezone information when user timezone is different from site timezone.
*/
const TimeZone = () => {
const { timezone } = getDateSettings();

// Convert timezone offset to hours.
const userTimezoneOffset = -1 * ( new Date().getTimezoneOffset() / 60 );

// System timezone and user timezone match, nothing needed.
// Compare as numbers because it comes over as string.
if ( Number( timezone.offset ) === userTimezoneOffset ) {
return null;
}

const offsetSymbol = timezone.offset >= 0 ? '+' : '';
const zoneAbbr =
'' !== timezone.abbr && isNaN( timezone.abbr )
? timezone.abbr
: `UTC${ offsetSymbol }${ timezone.offset }`;

const timezoneDetail =
'UTC' === timezone.string
? __( 'Coordinated Universal Time' )
: `(${ zoneAbbr }) ${ timezone.string.replace( '_', ' ' ) }`;

return (
<Tooltip position="top center" text={ timezoneDetail }>
<div className="components-datetime__timezone">{ zoneAbbr }</div>
</Tooltip>
);
};

export default TimeZone;
2 changes: 1 addition & 1 deletion packages/date/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ let settings = {
datetime: 'F j, Y g: i a',
datetimeAbbreviated: 'M j, Y g: i a',
},
timezone: { offset: '0', string: '' },
timezone: { offset: '0', string: '', abbr: '' },
};

/**
Expand Down