@atlaskit/datetime-picker 17.5.4 → 17.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/datetime-picker.docs.tsx +127 -0
- package/package.json +5 -4
package/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
4
|
+
|
|
5
|
+
const documentation: ComponentStructuredContentSource[] = [
|
|
6
|
+
{
|
|
7
|
+
name: 'DatePicker',
|
|
8
|
+
description: 'A component for selecting date values with calendar support.',
|
|
9
|
+
status: 'general-availability',
|
|
10
|
+
import: {
|
|
11
|
+
name: 'DatePicker',
|
|
12
|
+
package: '@atlaskit/datetime-picker',
|
|
13
|
+
type: 'named',
|
|
14
|
+
packagePath: path.resolve(__dirname),
|
|
15
|
+
packageJson: require('./package.json'),
|
|
16
|
+
},
|
|
17
|
+
usageGuidelines: [
|
|
18
|
+
'Use for date selection only',
|
|
19
|
+
'Provide clear date formats',
|
|
20
|
+
'Handle date validation appropriately',
|
|
21
|
+
'Consider calendar button visibility',
|
|
22
|
+
],
|
|
23
|
+
contentGuidelines: [
|
|
24
|
+
'Use clear, descriptive labels',
|
|
25
|
+
'Provide helpful placeholder text',
|
|
26
|
+
'Keep labels concise but descriptive',
|
|
27
|
+
'Use locale prop for date format localization',
|
|
28
|
+
],
|
|
29
|
+
accessibilityGuidelines: [
|
|
30
|
+
'Ensure proper keyboard navigation',
|
|
31
|
+
'Use appropriate date formats',
|
|
32
|
+
'Provide clear date labels',
|
|
33
|
+
'Consider screen reader announcements',
|
|
34
|
+
],
|
|
35
|
+
examples: [
|
|
36
|
+
{
|
|
37
|
+
name: 'Date Picker',
|
|
38
|
+
description: 'Date Picker example',
|
|
39
|
+
source: path.resolve(__dirname, './examples/ai/date-picker.tsx'),
|
|
40
|
+
},
|
|
41
|
+
],
|
|
42
|
+
keywords: ['date', 'picker', 'calendar', 'selection', 'form'],
|
|
43
|
+
categories: ['form'],
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
name: 'TimePicker',
|
|
47
|
+
description: 'A component for selecting time values with clock interface.',
|
|
48
|
+
status: 'general-availability',
|
|
49
|
+
import: {
|
|
50
|
+
name: 'TimePicker',
|
|
51
|
+
package: '@atlaskit/datetime-picker',
|
|
52
|
+
type: 'named',
|
|
53
|
+
packagePath: path.resolve(__dirname),
|
|
54
|
+
packageJson: require('./package.json'),
|
|
55
|
+
},
|
|
56
|
+
usageGuidelines: [
|
|
57
|
+
'Use for time selection only',
|
|
58
|
+
'Provide clear time formats',
|
|
59
|
+
'Handle time validation appropriately',
|
|
60
|
+
'Consider editable time input',
|
|
61
|
+
],
|
|
62
|
+
contentGuidelines: [
|
|
63
|
+
'Use clear, descriptive labels',
|
|
64
|
+
'Provide helpful placeholder text',
|
|
65
|
+
'Use appropriate time formats',
|
|
66
|
+
'Keep labels concise but descriptive',
|
|
67
|
+
'Use locale prop for time format localization (e.g. 12h vs 24h)',
|
|
68
|
+
],
|
|
69
|
+
accessibilityGuidelines: [
|
|
70
|
+
'Ensure proper keyboard navigation',
|
|
71
|
+
'Use appropriate time formats',
|
|
72
|
+
'Provide clear time labels',
|
|
73
|
+
'Consider screen reader announcements',
|
|
74
|
+
],
|
|
75
|
+
examples: [
|
|
76
|
+
{
|
|
77
|
+
name: 'Time Picker',
|
|
78
|
+
description: 'Time Picker example',
|
|
79
|
+
source: path.resolve(__dirname, './examples/ai/time-picker.tsx'),
|
|
80
|
+
},
|
|
81
|
+
],
|
|
82
|
+
keywords: ['time', 'picker', 'clock', 'selection', 'form'],
|
|
83
|
+
categories: ['form'],
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
name: 'DateTimePicker',
|
|
87
|
+
description: 'A component for selecting both date and time values.',
|
|
88
|
+
status: 'general-availability',
|
|
89
|
+
import: {
|
|
90
|
+
name: 'DateTimePicker',
|
|
91
|
+
package: '@atlaskit/datetime-picker',
|
|
92
|
+
type: 'named',
|
|
93
|
+
packagePath: path.resolve(__dirname),
|
|
94
|
+
packageJson: require('./package.json'),
|
|
95
|
+
},
|
|
96
|
+
usageGuidelines: [
|
|
97
|
+
'Use for combined date and time selection',
|
|
98
|
+
'Provide clear date/time formats',
|
|
99
|
+
'Handle timezone considerations',
|
|
100
|
+
'Consider validation requirements',
|
|
101
|
+
],
|
|
102
|
+
contentGuidelines: [
|
|
103
|
+
'Use clear, descriptive labels',
|
|
104
|
+
'Provide helpful placeholder text',
|
|
105
|
+
'Use appropriate date/time formats',
|
|
106
|
+
'Keep labels concise but descriptive',
|
|
107
|
+
'Use locale prop for date and time format localization',
|
|
108
|
+
],
|
|
109
|
+
accessibilityGuidelines: [
|
|
110
|
+
'Ensure proper keyboard navigation',
|
|
111
|
+
'Use appropriate date/time formats',
|
|
112
|
+
'Provide clear date/time labels',
|
|
113
|
+
'Consider screen reader announcements',
|
|
114
|
+
],
|
|
115
|
+
examples: [
|
|
116
|
+
{
|
|
117
|
+
name: 'Datetime Picker',
|
|
118
|
+
description: 'Datetime Picker example',
|
|
119
|
+
source: path.resolve(__dirname, './examples/ai/datetime-picker.tsx'),
|
|
120
|
+
},
|
|
121
|
+
],
|
|
122
|
+
keywords: ['datetime', 'picker', 'date', 'time', 'calendar'],
|
|
123
|
+
categories: ['form'],
|
|
124
|
+
},
|
|
125
|
+
];
|
|
126
|
+
|
|
127
|
+
export default documentation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/datetime-picker",
|
|
3
|
-
"version": "17.5.
|
|
3
|
+
"version": "17.5.5",
|
|
4
4
|
"description": "A date time picker allows the user to select an associated date and time.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"@atlaskit/calendar": "^17.2.0",
|
|
38
38
|
"@atlaskit/css": "^0.19.0",
|
|
39
39
|
"@atlaskit/ds-lib": "^6.0.0",
|
|
40
|
-
"@atlaskit/icon": "^
|
|
40
|
+
"@atlaskit/icon": "^33.0.0",
|
|
41
41
|
"@atlaskit/layering": "^3.6.0",
|
|
42
42
|
"@atlaskit/locale": "^3.0.0",
|
|
43
43
|
"@atlaskit/platform-feature-flags": "^1.1.0",
|
|
@@ -58,17 +58,18 @@
|
|
|
58
58
|
"@af/visual-regression": "workspace:^",
|
|
59
59
|
"@atlaskit/code": "^17.4.0",
|
|
60
60
|
"@atlaskit/codemod-utils": "^4.2.0",
|
|
61
|
-
"@atlaskit/docs": "^11.
|
|
61
|
+
"@atlaskit/docs": "^11.7.0",
|
|
62
62
|
"@atlaskit/form": "^15.4.0",
|
|
63
63
|
"@atlaskit/heading": "^5.3.0",
|
|
64
64
|
"@atlaskit/link": "^3.3.0",
|
|
65
65
|
"@atlaskit/modal-dialog": "^14.11.0",
|
|
66
66
|
"@atlaskit/popup": "^4.13.0",
|
|
67
|
-
"@atlaskit/range": "^
|
|
67
|
+
"@atlaskit/range": "^10.0.0",
|
|
68
68
|
"@atlaskit/section-message": "^8.12.0",
|
|
69
69
|
"@atlaskit/textfield": "^8.2.0",
|
|
70
70
|
"@atlaskit/toggle": "^15.2.0",
|
|
71
71
|
"@atlassian/ssr-tests": "workspace:^",
|
|
72
|
+
"@atlassian/structured-docs-types": "workspace:^",
|
|
72
73
|
"@testing-library/react": "^16.3.0",
|
|
73
74
|
"@testing-library/user-event": "^14.4.3",
|
|
74
75
|
"@types/testing-library__jest-dom": "^5.14.5",
|