@atlaskit/progress-indicator 10.0.0 → 10.0.1
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/dist/cjs/components/progress-dots.js +1 -1
- package/dist/es2019/components/progress-dots.js +1 -1
- package/dist/esm/components/progress-dots.js +1 -1
- package/dist/types/types.d.ts +8 -8
- package/dist/types-ts4.5/types.d.ts +8 -8
- package/package.json +4 -4
- package/tmp/api-report-tmp.d.ts +0 -42
package/CHANGELOG.md
CHANGED
|
@@ -9,7 +9,7 @@ import { getBgColor } from './appearances';
|
|
|
9
9
|
import { progressIndicatorGapMap, sizes, varDotsMargin, varDotsSize } from './constants';
|
|
10
10
|
import { ButtonIndicator, PresentationalIndicator } from './indicator';
|
|
11
11
|
const packageName = "@atlaskit/progress-indicator";
|
|
12
|
-
const packageVersion = "10.0.
|
|
12
|
+
const packageVersion = "10.0.1";
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
15
|
* __ProgressDots__
|
|
@@ -11,7 +11,7 @@ import { getBgColor } from './appearances';
|
|
|
11
11
|
import { progressIndicatorGapMap, sizes, varDotsMargin, varDotsSize } from './constants';
|
|
12
12
|
import { ButtonIndicator, PresentationalIndicator } from './indicator';
|
|
13
13
|
var packageName = "@atlaskit/progress-indicator";
|
|
14
|
-
var packageVersion = "10.0.
|
|
14
|
+
var packageVersion = "10.0.1";
|
|
15
15
|
|
|
16
16
|
/**
|
|
17
17
|
* __ProgressDots__
|
package/dist/types/types.d.ts
CHANGED
|
@@ -3,34 +3,34 @@ import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
|
3
3
|
import type { DotsAppearance, Size, Spacing } from './components/types';
|
|
4
4
|
export interface ProgressDotsProps {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Sets the color of the indicators.
|
|
7
7
|
*/
|
|
8
8
|
appearance?: DotsAppearance;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* If interaction is enabled, use `ariaControls` to tell assistive technology what elements are controlled by the progress indicator.
|
|
11
11
|
*/
|
|
12
12
|
ariaControls?: string;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Describes what the indicator represents to assistive technology. The selected index number will be appended to the label.
|
|
15
15
|
*/
|
|
16
16
|
ariaLabel?: string;
|
|
17
17
|
/**
|
|
18
|
-
* Function called when an indicator is selected
|
|
18
|
+
* Function called when an indicator is selected.
|
|
19
19
|
*/
|
|
20
20
|
onSelect?: (eventData: {
|
|
21
21
|
event: React.MouseEvent<HTMLButtonElement>;
|
|
22
22
|
index: number;
|
|
23
23
|
}, analyticsEvent: UIAnalyticsEvent) => void;
|
|
24
24
|
/**
|
|
25
|
-
* Which indicator is currently selected
|
|
25
|
+
* Which indicator is currently selected.
|
|
26
26
|
*/
|
|
27
27
|
selectedIndex: number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Sets the width and height of each indicator.
|
|
30
30
|
*/
|
|
31
31
|
size?: Size;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Specifies how much of a gutter there is between indicators.
|
|
34
34
|
*/
|
|
35
35
|
spacing?: Spacing;
|
|
36
36
|
/**
|
|
@@ -38,7 +38,7 @@ export interface ProgressDotsProps {
|
|
|
38
38
|
*/
|
|
39
39
|
testId?: string;
|
|
40
40
|
/**
|
|
41
|
-
* An array of values mapped over to create the indicators
|
|
41
|
+
* An array of values mapped over to create the indicators.
|
|
42
42
|
*/
|
|
43
43
|
values: any[];
|
|
44
44
|
}
|
|
@@ -3,34 +3,34 @@ import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
|
3
3
|
import type { DotsAppearance, Size, Spacing } from './components/types';
|
|
4
4
|
export interface ProgressDotsProps {
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Sets the color of the indicators.
|
|
7
7
|
*/
|
|
8
8
|
appearance?: DotsAppearance;
|
|
9
9
|
/**
|
|
10
|
-
*
|
|
10
|
+
* If interaction is enabled, use `ariaControls` to tell assistive technology what elements are controlled by the progress indicator.
|
|
11
11
|
*/
|
|
12
12
|
ariaControls?: string;
|
|
13
13
|
/**
|
|
14
|
-
*
|
|
14
|
+
* Describes what the indicator represents to assistive technology. The selected index number will be appended to the label.
|
|
15
15
|
*/
|
|
16
16
|
ariaLabel?: string;
|
|
17
17
|
/**
|
|
18
|
-
* Function called when an indicator is selected
|
|
18
|
+
* Function called when an indicator is selected.
|
|
19
19
|
*/
|
|
20
20
|
onSelect?: (eventData: {
|
|
21
21
|
event: React.MouseEvent<HTMLButtonElement>;
|
|
22
22
|
index: number;
|
|
23
23
|
}, analyticsEvent: UIAnalyticsEvent) => void;
|
|
24
24
|
/**
|
|
25
|
-
* Which indicator is currently selected
|
|
25
|
+
* Which indicator is currently selected.
|
|
26
26
|
*/
|
|
27
27
|
selectedIndex: number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* Sets the width and height of each indicator.
|
|
30
30
|
*/
|
|
31
31
|
size?: Size;
|
|
32
32
|
/**
|
|
33
|
-
*
|
|
33
|
+
* Specifies how much of a gutter there is between indicators.
|
|
34
34
|
*/
|
|
35
35
|
spacing?: Spacing;
|
|
36
36
|
/**
|
|
@@ -38,7 +38,7 @@ export interface ProgressDotsProps {
|
|
|
38
38
|
*/
|
|
39
39
|
testId?: string;
|
|
40
40
|
/**
|
|
41
|
-
* An array of values mapped over to create the indicators
|
|
41
|
+
* An array of values mapped over to create the indicators.
|
|
42
42
|
*/
|
|
43
43
|
values: any[];
|
|
44
44
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/progress-indicator",
|
|
3
|
-
"version": "10.0.
|
|
3
|
+
"version": "10.0.1",
|
|
4
4
|
"description": "A progress indicator shows the user where they are along the steps of a journey.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -29,9 +29,9 @@
|
|
|
29
29
|
"@atlaskit/analytics-next": "^9.1.0",
|
|
30
30
|
"@atlaskit/ds-lib": "^2.2.0",
|
|
31
31
|
"@atlaskit/focus-ring": "^1.3.0",
|
|
32
|
-
"@atlaskit/primitives": "^
|
|
32
|
+
"@atlaskit/primitives": "^2.0.0",
|
|
33
33
|
"@atlaskit/theme": "^12.6.0",
|
|
34
|
-
"@atlaskit/tokens": "^1.
|
|
34
|
+
"@atlaskit/tokens": "^1.35.0",
|
|
35
35
|
"@babel/runtime": "^7.0.0",
|
|
36
36
|
"@emotion/react": "^11.7.1",
|
|
37
37
|
"bind-event-listener": "^2.1.1"
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"devDependencies": {
|
|
43
43
|
"@af/accessibility-testing": "*",
|
|
44
44
|
"@af/visual-regression": "*",
|
|
45
|
-
"@atlaskit/ds-explorations": "^3.
|
|
45
|
+
"@atlaskit/ds-explorations": "^3.2.0",
|
|
46
46
|
"@atlaskit/ssr": "*",
|
|
47
47
|
"@atlaskit/visual-regression": "*",
|
|
48
48
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|
package/tmp/api-report-tmp.d.ts
DELETED
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/progress-indicator"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
/// <reference types="react" />
|
|
8
|
-
|
|
9
|
-
import { FC } from 'react';
|
|
10
|
-
import type { UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
11
|
-
|
|
12
|
-
// @public (undocumented)
|
|
13
|
-
type DotsAppearance = 'default' | 'help' | 'inverted' | 'primary';
|
|
14
|
-
|
|
15
|
-
// @public (undocumented)
|
|
16
|
-
export interface ProgressDotsProps {
|
|
17
|
-
appearance?: DotsAppearance;
|
|
18
|
-
ariaControls?: string;
|
|
19
|
-
ariaLabel?: string;
|
|
20
|
-
onSelect?: (eventData: {
|
|
21
|
-
event: React.MouseEvent<HTMLButtonElement>;
|
|
22
|
-
index: number;
|
|
23
|
-
}, analyticsEvent: UIAnalyticsEvent) => void;
|
|
24
|
-
selectedIndex: number;
|
|
25
|
-
size?: Size;
|
|
26
|
-
spacing?: Spacing;
|
|
27
|
-
testId?: string;
|
|
28
|
-
values: any[];
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
// @public
|
|
32
|
-
export const ProgressIndicator: FC<ProgressDotsProps>;
|
|
33
|
-
|
|
34
|
-
// @public (undocumented)
|
|
35
|
-
type Size = 'default' | 'large' | 'small';
|
|
36
|
-
|
|
37
|
-
// @public (undocumented)
|
|
38
|
-
type Spacing = 'comfortable' | 'compact' | 'cozy';
|
|
39
|
-
|
|
40
|
-
// (No @packageDocumentation comment for this package)
|
|
41
|
-
|
|
42
|
-
```
|