[datetime2] feat: new package with timezone-aware components

.circleci/config.yml

@@ -14,23 +14,23 @@ aliases:
 
   - &restore-node-modules-cache
     name: Restore node_modules cache
-    key: v4-yarn-deps-{{ checksum "yarn.lock" }}
+    key: v5-yarn-deps-{{ checksum "yarn.lock" }}
 
   - &restore-yarn-cache
     name: Restore yarnpkg cache
-    key: v4-yarn-cache
+    key: v5-yarn-cache
 
   - &save-node-modules-cache
     name: Save node_modules cache
     paths:
       - node_modules
-    key: v4-yarn-deps-{{ checksum "yarn.lock" }}
+    key: v5-yarn-deps-{{ checksum "yarn.lock" }}
 
   - &save-yarn-cache
     name: Save yarnpkg cache
     paths:
       - ~/.cache/yarn
-    key: v4-yarn-cache
+    key: v5-yarn-cache
 
 references:
   reports_path: &reports_path
@@ -138,7 +138,7 @@ jobs:
     environment:
       JUNIT_REPORT_PATH: reports
       NODE_ENV: test
-    parallelism: 7
+    parallelism: 8
     steps:
       - checkout
       - restore_cache: *restore-node-modules-cache
@@ -160,10 +160,11 @@ jobs:
             0) yarn lerna run --parallel test:typeCheck ;; \
             1) yarn lerna run --scope "@blueprintjs/core" test:karma ;; \
             2) yarn lerna run --scope "@blueprintjs/datetime" test:karma ;; \
-            3) yarn lerna run --scope "@blueprintjs/popover2" test:karma ;; \
-            4) yarn lerna run --scope "@blueprintjs/select" test:karma ;; \
-            5) yarn lerna run --scope "@blueprintjs/table" test:karma ;; \
-            6) yarn lerna run --scope "@blueprintjs/timezone" test:karma ;; \
+            3) yarn lerna run --scope "@blueprintjs/datetime2" test:karma ;; \
+            4) yarn lerna run --scope "@blueprintjs/popover2" test:karma ;; \
+            5) yarn lerna run --scope "@blueprintjs/select" test:karma ;; \
+            6) yarn lerna run --scope "@blueprintjs/table" test:karma ;; \
+            7) yarn lerna run --scope "@blueprintjs/timezone" test:karma ;; \
             esac
           when: always
       - store_test_results: { path: ./reports }

package.json

@@ -18,11 +18,12 @@
         "dev:core": "lerna run dev --parallel --scope \"@blueprintjs/{core,icons,docs-app}\"",
         "dev:docs": "lerna run dev --parallel --scope \"@blueprintjs/{core,docs-app,docs-theme}\"",
         "dev:datetime": "lerna run dev --parallel --scope \"@blueprintjs/{datetime,timezone,docs-app}\"",
+        "dev:datetime2": "lerna run dev --parallel --scope \"@blueprintjs/{datetime2,docs-app}\"",
         "dev:popover2": "lerna run dev --parallel --scope \"@blueprintjs/{popover2,docs-app}\"",
         "dev:select": "lerna run dev --parallel --scope \"@blueprintjs/{select,docs-app}\"",
         "dev:table": "lerna run dev --parallel --scope \"@blueprintjs/{table,table-dev-app}\"",
         "dist": "run-s dist:libs dist:apps",
-        "dist:libs": "lerna run dist --parallel --scope \"@blueprintjs/{colors,core,datetime,docs-theme,icons,popover2,select,table,timezone}\"",
+        "dist:libs": "lerna run dist --parallel --scope \"@blueprintjs/{colors,core,datetime,datetime2, docs-theme,icons,popover2,select,table,timezone}\"",
         "dist:apps": "lerna run dist --parallel --scope \"@blueprintjs/{docs-app,landing-app,table-dev-app,demo-app}\"",
         "docs-data": "lerna run compile --scope \"@blueprintjs/docs-data\"",
         "format": "prettier --write \"./**/*.{ts,tsx,json}\"",

packages/datetime/src/_datepicker.scss

@@ -198,6 +198,13 @@ $header-margin: ($header-height - $pt-input-height) * 0.5 !default;
   padding-left: $datepicker-padding;
 }
 
+.#{$ns}-datepicker-content {
+  align-items: center;
+  display: flex;
+  flex-direction: column;
+  gap: 5px;
+}
+
 .#{$ns}-datepicker-footer {
   display: flex;
   justify-content: space-between;

packages/datetime/src/common/classes.ts

@@ -26,6 +26,7 @@ export const DATEPICKER_CAPTION = `${DATEPICKER}-caption`;
 export const DATEPICKER_CAPTION_CARET = `${DATEPICKER_CAPTION}-caret`;
 export const DATEPICKER_CAPTION_MEASURE = `${DATEPICKER_CAPTION}-measure`;
 export const DATEPICKER_CAPTION_SELECT = `${DATEPICKER_CAPTION}-select`;
+export const DATEPICKER_CONTENT = `${DATEPICKER}-content`;
 export const DATEPICKER_DAY = "DayPicker-Day";
 export const DATEPICKER_DAY_DISABLED = `${DATEPICKER_DAY}--disabled`;
 export const DATEPICKER_DAY_OUTSIDE = `${DATEPICKER_DAY}--outside`;

packages/datetime/src/datePicker.tsx

@@ -143,13 +143,14 @@ export class DatePicker extends AbstractPureComponent2<DatePickerProps, IDatePic
     }
 
     public render() {
-        const { className, dayPickerProps, locale, localeUtils, maxDate, minDate, showActionsBar } = this.props;
+        const { className, dayPickerProps, footerElement, locale, localeUtils, maxDate, minDate, showActionsBar } =
+            this.props;
         const { displayMonth, displayYear } = this.state;
 
         return (
             <div className={classNames(Classes.DATEPICKER, className)}>
                 {this.maybeRenderShortcuts()}
-                <div>
+                <div className={Classes.DATEPICKER_CONTENT}>
                     <DayPicker
                         showOutsideDays={true}
                         locale={locale}
@@ -170,6 +171,7 @@ export class DatePicker extends AbstractPureComponent2<DatePickerProps, IDatePic
                     />
                     {this.maybeRenderTimePicker()}
                     {showActionsBar && this.renderOptionsBar()}
+                    {footerElement}
                 </div>
             </div>
         );

packages/datetime/src/datePickerCore.tsx

@@ -50,6 +50,11 @@ export interface IDatePickerBaseProps {
      */
     dayPickerProps?: DayPickerProps;
 
+    /**
+     * An additional element to show below the date picker
+     */
+    footerElement?: JSX.Element;
+
     /**
      * Whether the current day should be highlighted in the calendar.
      *

packages/datetime/src/dateinput.md

@@ -1,7 +1,18 @@
 @# Date input
 
-The `DateInput` component is an [input group](#core/components/text-inputs.input-group)
-that shows a [`DatePicker`](#datetime/datepicker) in a [`Popover`](#core/components/popover)
+<div class="@ns-callout @ns-intent-success @ns-icon-star">
+    <h4 class="@ns-heading">Newer API available</h4>
+
+There is an updated version of this component available in the new
+[__@blueprintjs/datetime2__ package](#datetime2) called
+[DateInput2](#datetime2/date-input2). Its API is currently in development,
+but you are encouraged to try it out and provide feedback for the next
+version of the Blueprint date input.
+
+</div>
+
+The DateInput component is an [InputGroup](#core/components/text-inputs.input-group)
+that shows a [DatePicker](#datetime/datepicker) in a [Popover](#core/components/popover)
 on focus. Use it in forms where the user must enter a date.
 
 @reactExample DateInputExample
@@ -18,9 +29,9 @@ The optional `locale` argument is the value of the `locale` prop.
 A simple implementation using built-in browser methods could look like this:
 
 ```tsx
-import { DateInput, IDateFormatProps } from "@blueprintjs/datetime";
+import { DateInput, DateFormatProps } from "@blueprintjs/datetime";
 
-const jsDateFormatter: IDateFormatProps = {
+const jsDateFormatter: DateFormatProps = {
     // note that the native implementation of Date functions differs between browsers
     formatDate: date => date.toLocaleDateString(),
     parseDate: str => new Date(str),
@@ -33,10 +44,10 @@ const jsDateFormatter: IDateFormatProps = {
 An implementation using `moment.js` could look like this:
 
 ```tsx
-import { DateInput, IDateFormatProps } from "@blueprintjs/datetime";
+import { DateInput, DateFormatProps } from "@blueprintjs/datetime";
 import moment from "moment";
 
-function getMomentFormatter(format: string): IDateFormatProps {
+function getMomentFormatter(format: string): DateFormatProps {
     // note that locale argument comes from locale prop and may be undefined
     return {
         formatDate: (date, locale) => moment(date).locale(locale).format(format),

packages/datetime/test/isotest.js

@@ -15,7 +15,7 @@
 
 require("@blueprintjs/test-commons/bootstrap");
 const { generateIsomorphicTests } = require("@blueprintjs/test-commons");
-const React = require("react");
+
 const DateTime = require("../lib/cjs");
 
 describe("DateTime isomorphic rendering", () => {

packages/datetime2/.npmignore

@@ -0,0 +1,5 @@
+coverage/
+test/
+webpack.config.js
+karma.conf.js
+.npmrc

packages/datetime2/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

packages/datetime2/README.md

@@ -0,0 +1,31 @@
+<img height="204" src="https://cloud.githubusercontent.com/assets/464822/20228152/d3f36dc2-a804-11e6-80ff-51ada2d13ea7.png">
+
+# [Blueprint](http://blueprintjs.com/) Date & Time Components (V2)
+
+Blueprint is a React UI toolkit for the web.
+
+This package contains a collection of React components for working with dates
+and times. These are modern variants of the components available in the
+`@blueprintjs/datetime` package; they will become the standard date & time
+components in a future major version of Blueprint.
+
+Compared to their "V1" counterparts, these components:
+- use Popover2 instead of Popover under the hood
+- have better timezone awareness
+- utilize lightweight dependencies for manipulating dates and displaying
+  the list of available timezones
+- no longer use the deprecated moment.js library
+
+At the moment, `@blueprintjs/datetime` is a dependency of this
+package, as it delegates to the `<DatePicker>` and `<DateRangePicker>`
+implementation exported from there. When these "V2" components graduate
+to become the standard API, all Blueprint date/time components will
+be collected into a single package, `@blueprintjs/datetime@5.x`.
+
+## Installation
+
+```
+npm install --save @blueprintjs/datetime2
+```
+
+### [Full Documentation](http://blueprintjs.com/docs) | [Source Code](https://github.com/palantir/blueprint)