npmpackage.info

Gathering detailed insights and metrics for @commercetools-uikit/date-range-field

@commercetools-uikit/date-range-field - 20.2.2 | npmpackage.info

@commercetools-uikit/date-range-field

Component library 💅

20.2.2

148

MIT

TypeScript

47.35 kB

7.3

Installations

npm install @commercetools-uikit/date-range-field

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

22.17.0

NPM Version

10.9.2 Pull Requests

Open

20

Total

2,855

Closed

578

Merged

2,257

Issues

Open

43

Total

292

Closed

249

Releases

8,198

v20.2.2

Updated on Jul 08, 2025

v20.2.1

Updated on Jul 07, 2025

v20.2.0

Updated on Jun 30, 2025

v20.1.0

Updated on Jun 16, 2025

v20.0.0

Updated on Jun 02, 2025

v19.26.0

Updated on May 27, 2025

View All 8,198 releases

Languages

TypeScript

JavaScript

MDX

CSS

HTML

Prolog

Shell

TypeScript (59.12%)

JavaScript (36.8%)

MDX (2.8%)

CSS (1.02%)

HTML (0.16%)

Prolog (0.06%)

Shell (0.04%)

Developer

commercetools

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

148 Stars

3,452 Commits

27 Forks

15 Watchers

124 Branches

350 Contributors

Updated on Jul 09, 2025

Maintainers

View All 350 Contributors

Package Meta Information

Latest Version

20.2.2

Package Id

@commercetools-uikit/date-range-field@20.2.2

Unpacked Size

47.35 kB

Size

7.81 kB

File Count

NPM Version

10.9.2

Node Version

22.17.0

Published on

Jul 08, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

DateRangeField

Description

A controlled date input component for a date range, with validation states and a label.

Installation

yarn add @commercetools-uikit/date-range-field

npm --save install @commercetools-uikit/date-range-field

Additionally install the peer dependencies (if not present)

yarn add react

npm --save install react

Usage

1import DateRangeField from '@commercetools-uikit/date-range-field';
2
3const Example = () => (
4  <DateRangeField
5    title="Release Date"
6    value={['2018-09-20', '2018-09-24']}
7    onChange={(event) => alert(event.target.value)}
8  />
9);
10
11export default Example;

Properties

Props	Type	Required	Default	Description
`id`	`string`			Used as HTML id property. An id is auto-generated when it is not specified.
`horizontalConstraint`	`union` Possible values: `, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 'scale', 'auto'`		`'scale'`	Horizontal size limit of the input fields.
`errors`	`Record`			A map of errors. Error messages for known errors are rendered automatically. Unknown errors will be forwarded to `renderError`
`renderError`	`Function` See signature.			Called with custom errors. This function can return a message which will be wrapped in an ErrorMessage. It can also return null to show no error.
`warnings`	`Record`			A map of warnings. Warning messages for known warnings are rendered automatically. Unknown warnings will be forwarded to renderWarning.
`renderWarning`	`Function` See signature.			Called with custom warnings, as renderWarning(key, warning). This function can return a message which will be wrapped in a WarningMessage. It can also return null to show no warning.
`isRequired`	`boolean`			Indicates if the value is required. Shows an the "required asterisk" if so.
`touched`	`boolean`			Indicates whether the field was touched. Errors will only be shown when the field was touched.
`name`	`string`			Used as HTML name of the input component.
`value`	`Array: string[]`	✅		The selected date range. Must either be an empty array or an array of two strings holding dates formatted as "YYYY-MM-DD".
`onChange`	`Function` See signature.			Called when the date range changes, with an event containing either an empty array (no value) or an array holding two string in this format: "YYYY-MM-DD". Required when input is not read only.
`onBlur`	`Function` See signature.			Called when input is blurred
`onFocus`	`Function` See signature.			Called when input is focused
`isDisabled`	`boolean`			Indicates that the input cannot be modified (e.g not authorized, or changes currently saving).
`isReadOnly`	`boolean`			Indicates that the field is displaying read-only content
`placeholder`	`string`			Placeholder text for the input
`isCondensed`	`boolean`			Use this property to reduce the paddings of the component for a ui compact variant
`title`	`union` Possible values: `string , ReactNode`	✅		Title of the label
`hint`	`union` Possible values: `string , ReactNode`			Hint for the label. Provides a supplementary but important information regarding the behaviour of the input (e.g warn about uniqueness of a field, when it can only be set once), whereas `description` can describe it in more depth. Can also receive a `hintIcon`.
`description`	`union` Possible values: `string , ReactNode`			Provides a description for the title.
`onInfoButtonClick`	`Function` See signature.			Function called when info button is pressed. Info button will only be visible when this prop is passed.
`hintIcon`	`ReactElement`			Icon to be displayed beside the hint text. Will only get rendered when `hint` is passed as well.
`badge`	`ReactNode`			Badge to be displayed beside the label. Might be used to display additional information about the content of the field (E.g verified email)

Signatures

Signature `renderError`

1(key: string, error?: boolean) => ReactNode;

Signature `renderWarning`

1(key: string, warning?: boolean) => ReactNode;

Signature `onChange`

1(event: TCustomEvent) => void

Signature `onBlur`

1(event: TCustomEvent) => void

Signature `onFocus`

1(event: TCustomEvent) => void

Signature `onInfoButtonClick`

1() => void

`data-*` props

The component further forwards all data- attributes to the underlying input component.

`errors`

This object is a key-value map. The renderError prop will be called for each entry with the key and the value. The return value will be rendered inside an ErrorMessage component underneath the input.

The DateRangeField supports some errors out of the box. Return undefined from renderError for these and the default errors will be shown instead. This prevents consumers from having to reimplement the same error messages for known errors while still keeping the flexibility of showing custom error messages for them.

When the key is known, and when the value is truthy, and when renderError returned undefined for that error entry, then the DateRangeField will render an appropriate error automatically.

Known error keys are:

missing: tells the user that this field is required

Main Functions and use cases are:

Input field for a single date

Static methods

`DateRangeField.toFieldErrors`

Use this function to convert the Formik errors object type to our custom field errors type. This is primarily useful when using TypeScript.

1type FormValues = {
2  myField: string;
3};
4
5<DateRangeField
6  // ...
7  name="my-field"
8  errors={DateRangeField.toFieldErrors<FormValues>(formik.errors).myField}
9/>;

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

SAST

Determines if the project uses static code analysis.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

8

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-inactive-issues.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/close-inactive-issues.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/main.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/merge-blocking-labels.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/merge-blocking-labels.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/preview-release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/preview-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/preview-release.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/preview-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-release.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/preview-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-release.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/preview-release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/preview-release.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/preview-release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/release.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/ui-kit/release.yml/main?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.3

/10

Last Scanned on 2025-07-14

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@commercetools-uikit/date-range-field

Installations

Developer Guide

Yes

CommonJS

22.17.0

10.9.2

Pull Requests

20

2,855

578

2,257

Issues

43

292

249

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

DateRangeField

Description

Installation

Usage

Properties

Signatures

Signature renderError

Signature renderWarning

Signature onChange

Signature onBlur

Signature onFocus

Signature onInfoButtonClick

data-* props

errors

Main Functions and use cases are:

Static methods

DateRangeField.toFieldErrors

10

10

10

10

10

10

9

8

8

0

0

0

0

7.3

/10

Signature `renderError`

Signature `renderWarning`

Signature `onChange`

Signature `onBlur`

Signature `onFocus`

Signature `onInfoButtonClick`

`data-*` props

`errors`

`DateRangeField.toFieldErrors`