@atlaskit/side-navigation 1.8.3 → 1.8.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 +12 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/package.json +3 -3
- package/tmp/api-report-tmp.d.ts +228 -0
package/CHANGELOG.md
CHANGED
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/side-navigation",
|
|
3
|
-
"version": "1.8.
|
|
3
|
+
"version": "1.8.5",
|
|
4
4
|
"description": "A highly composable side navigation component that supports nested views.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"atlassian": {
|
|
26
26
|
"team": "Design System Team",
|
|
27
27
|
"deprecatedAutoEntryPoints": true,
|
|
28
|
-
"releaseModel": "
|
|
28
|
+
"releaseModel": "continuous",
|
|
29
29
|
"website": {
|
|
30
30
|
"name": "Side navigation",
|
|
31
31
|
"category": "Components"
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"@atlaskit/icon": "^21.12.0",
|
|
38
38
|
"@atlaskit/menu": "^1.7.0",
|
|
39
39
|
"@atlaskit/motion": "^1.4.0",
|
|
40
|
-
"@atlaskit/primitives": "^0.
|
|
40
|
+
"@atlaskit/primitives": "^0.11.0",
|
|
41
41
|
"@atlaskit/theme": "^12.5.0",
|
|
42
42
|
"@atlaskit/tokens": "^1.5.0",
|
|
43
43
|
"@babel/runtime": "^7.0.0",
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/side-navigation"
|
|
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 { ButtonItemProps } from '@atlaskit/menu';
|
|
10
|
+
import { CSSFn } from '@atlaskit/menu';
|
|
11
|
+
import { CustomItemComponentProps } from '@atlaskit/menu';
|
|
12
|
+
import { CustomItemProps } from '@atlaskit/menu';
|
|
13
|
+
import { ForwardRefExoticComponent } from 'react';
|
|
14
|
+
import { HeadingItemProps } from '@atlaskit/menu';
|
|
15
|
+
import { HTMLAttributes } from 'react';
|
|
16
|
+
import { jsx } from '@emotion/react';
|
|
17
|
+
import { LinkItemProps } from '@atlaskit/menu';
|
|
18
|
+
import { Overrides } from '@atlaskit/menu';
|
|
19
|
+
import { default as React_2 } from 'react';
|
|
20
|
+
import { ReactNode } from 'react';
|
|
21
|
+
import { RefAttributes } from 'react';
|
|
22
|
+
import { SkeletonHeadingItemProps } from '@atlaskit/menu';
|
|
23
|
+
import { SkeletonItemProps } from '@atlaskit/menu';
|
|
24
|
+
|
|
25
|
+
// @public
|
|
26
|
+
export const ButtonItem: React_2.ForwardRefExoticComponent<ButtonItemProps & React_2.RefAttributes<HTMLElement>>;
|
|
27
|
+
|
|
28
|
+
export { ButtonItemProps }
|
|
29
|
+
export { ButtonItemProps as GoBackItemProps }
|
|
30
|
+
|
|
31
|
+
// @public
|
|
32
|
+
export const CustomItem: CustomItemPropsHack;
|
|
33
|
+
|
|
34
|
+
export { CustomItemComponentProps }
|
|
35
|
+
|
|
36
|
+
export { CustomItemProps }
|
|
37
|
+
|
|
38
|
+
// @public (undocumented)
|
|
39
|
+
interface CustomItemPropsHack {
|
|
40
|
+
// (undocumented)
|
|
41
|
+
<TComponentProps extends {}>(props: CustomItemProps<TComponentProps> & {
|
|
42
|
+
ref?: any;
|
|
43
|
+
} & Omit<TComponentProps, keyof CustomItemComponentProps>): JSX.Element | null;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// @public
|
|
47
|
+
export const Footer: ({ useDeprecatedApi, description, iconBefore, testId, children, component, cssFn, onClick, }: FooterFacadeProps) => JSX.Element;
|
|
48
|
+
|
|
49
|
+
// @public (undocumented)
|
|
50
|
+
type FooterFacadeProps = (HeaderProps & {
|
|
51
|
+
useDeprecatedApi?: true;
|
|
52
|
+
}) | (NewFooterProps & {
|
|
53
|
+
useDeprecatedApi?: false;
|
|
54
|
+
cssFn?: never;
|
|
55
|
+
component?: never;
|
|
56
|
+
onClick?: never;
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
// @public (undocumented)
|
|
60
|
+
export type FooterProps = HeaderProps | NewFooterProps;
|
|
61
|
+
|
|
62
|
+
// @public
|
|
63
|
+
export const GoBackItem: React_2.ForwardRefExoticComponent<ButtonItemProps & React_2.RefAttributes<HTMLElement>>;
|
|
64
|
+
|
|
65
|
+
// @public
|
|
66
|
+
export const Header: React_2.ForwardRefExoticComponent<HeaderProps & React_2.RefAttributes<HTMLElement>>;
|
|
67
|
+
|
|
68
|
+
// @public (undocumented)
|
|
69
|
+
export type HeaderProps = {
|
|
70
|
+
cssFn?: CSSFn;
|
|
71
|
+
iconBefore?: React_2.ReactNode;
|
|
72
|
+
onClick?: (event: React_2.KeyboardEvent | React_2.MouseEvent) => void;
|
|
73
|
+
description?: JSX.Element | string;
|
|
74
|
+
children?: React_2.ReactNode;
|
|
75
|
+
testId?: string;
|
|
76
|
+
component?: React_2.ComponentType<CustomItemComponentProps>;
|
|
77
|
+
};
|
|
78
|
+
|
|
79
|
+
// @public
|
|
80
|
+
export const HeadingItem: (props: HeadingItemProps) => JSX.Element | null;
|
|
81
|
+
|
|
82
|
+
export { HeadingItemProps }
|
|
83
|
+
|
|
84
|
+
// @public
|
|
85
|
+
export const LinkItem: React_2.ForwardRefExoticComponent<LinkItemProps & React_2.RefAttributes<HTMLElement>>;
|
|
86
|
+
|
|
87
|
+
export { LinkItemProps }
|
|
88
|
+
|
|
89
|
+
// @public
|
|
90
|
+
export const LoadingItems: ({ children, isLoading, fallback, testId, }: LoadingItemsProps) => JSX.Element;
|
|
91
|
+
|
|
92
|
+
// @public (undocumented)
|
|
93
|
+
export interface LoadingItemsProps {
|
|
94
|
+
children: React.ReactNode;
|
|
95
|
+
fallback: React.ReactNode;
|
|
96
|
+
isLoading?: boolean;
|
|
97
|
+
testId?: string;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
// @public
|
|
101
|
+
export const NavigationContent: ForwardRefExoticComponent<NavigationContentProps & HTMLAttributes<HTMLElement> & RefAttributes<HTMLElement>>;
|
|
102
|
+
|
|
103
|
+
// @public (undocumented)
|
|
104
|
+
export interface NavigationContentProps {
|
|
105
|
+
// (undocumented)
|
|
106
|
+
children: React.ReactNode;
|
|
107
|
+
showTopScrollIndicator?: boolean;
|
|
108
|
+
testId?: string;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// @public
|
|
112
|
+
export const NavigationFooter: ({ children }: NavigationFooterProps) => jsx.JSX.Element;
|
|
113
|
+
|
|
114
|
+
// @public (undocumented)
|
|
115
|
+
export interface NavigationFooterProps {
|
|
116
|
+
// (undocumented)
|
|
117
|
+
children: ReactNode;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// @public
|
|
121
|
+
export const NavigationHeader: (props: NavigationHeaderProps) => jsx.JSX.Element;
|
|
122
|
+
|
|
123
|
+
// @public (undocumented)
|
|
124
|
+
export interface NavigationHeaderProps {
|
|
125
|
+
// (undocumented)
|
|
126
|
+
children: JSX.Element | JSX.Element[];
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
// @public
|
|
130
|
+
export const NestableNavigationContent: (props: NestableNavigationContentProps) => jsx.JSX.Element;
|
|
131
|
+
|
|
132
|
+
// @public (undocumented)
|
|
133
|
+
export interface NestableNavigationContentProps {
|
|
134
|
+
children: JSX.Element | JSX.Element[];
|
|
135
|
+
initialStack?: string[];
|
|
136
|
+
onChange?: (stack: string[]) => void;
|
|
137
|
+
onUnknownNest?: (stack: string[]) => void;
|
|
138
|
+
// @deprecated
|
|
139
|
+
overrides?: {
|
|
140
|
+
GoBackItem?: {
|
|
141
|
+
render?: (props: {
|
|
142
|
+
onClick: () => void;
|
|
143
|
+
testId?: string;
|
|
144
|
+
}) => React.ReactNode;
|
|
145
|
+
};
|
|
146
|
+
};
|
|
147
|
+
stack?: string[];
|
|
148
|
+
testId?: string;
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
// @public
|
|
152
|
+
export const NestingItem: <TCustomComponentProps extends CustomItemComponentProps>(props: NestingItemProps<TCustomComponentProps> & Omit<TCustomComponentProps, keyof CustomItemComponentProps>) => JSX.Element;
|
|
153
|
+
|
|
154
|
+
// @public (undocumented)
|
|
155
|
+
interface NestingItemOverrides extends Overrides {
|
|
156
|
+
GoBackItem?: {
|
|
157
|
+
render?: (props: {
|
|
158
|
+
onClick: () => void;
|
|
159
|
+
testId?: string;
|
|
160
|
+
}) => React_2.ReactNode;
|
|
161
|
+
};
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// @public (undocumented)
|
|
165
|
+
export interface NestingItemProps<TCustomComponentProps = CustomItemComponentProps> {
|
|
166
|
+
children: React_2.ReactNode;
|
|
167
|
+
component?: React_2.ComponentType<TCustomComponentProps>;
|
|
168
|
+
cssFn?: CSSFn;
|
|
169
|
+
description?: JSX.Element | string;
|
|
170
|
+
iconAfter?: React_2.ReactNode;
|
|
171
|
+
iconBefore?: React_2.ReactNode;
|
|
172
|
+
id: string;
|
|
173
|
+
isDisabled?: boolean;
|
|
174
|
+
isSelected?: boolean;
|
|
175
|
+
onClick?: (event: React_2.KeyboardEvent | React_2.MouseEvent) => void;
|
|
176
|
+
overrides?: NestingItemOverrides;
|
|
177
|
+
testId?: string;
|
|
178
|
+
title: React_2.ReactNode;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
// @public (undocumented)
|
|
182
|
+
type NewFooterProps = Omit<HeaderProps, 'component' | 'cssFn' | 'onClick'>;
|
|
183
|
+
|
|
184
|
+
// @public
|
|
185
|
+
export const Section: React_2.ForwardRefExoticComponent<SectionProps & React_2.RefAttributes<HTMLElement>>;
|
|
186
|
+
|
|
187
|
+
// @public (undocumented)
|
|
188
|
+
export interface SectionProps {
|
|
189
|
+
children: React_2.ReactNode;
|
|
190
|
+
hasSeparator?: boolean;
|
|
191
|
+
testId?: string;
|
|
192
|
+
title?: string;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
// @public
|
|
196
|
+
export const SideNavigation: ForwardRefExoticComponent<SideNavigationProps & RefAttributes<HTMLElement>>;
|
|
197
|
+
|
|
198
|
+
// @public (undocumented)
|
|
199
|
+
export interface SideNavigationProps {
|
|
200
|
+
children: JSX.Element | JSX.Element[];
|
|
201
|
+
label: string;
|
|
202
|
+
testId?: string;
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// @public
|
|
206
|
+
export const SkeletonHeadingItem: (props: SkeletonHeadingItemProps) => JSX.Element | null;
|
|
207
|
+
|
|
208
|
+
export { SkeletonHeadingItemProps }
|
|
209
|
+
|
|
210
|
+
// @public
|
|
211
|
+
export const SkeletonItem: (props: SkeletonItemProps) => JSX.Element | null;
|
|
212
|
+
|
|
213
|
+
export { SkeletonItemProps }
|
|
214
|
+
|
|
215
|
+
// @public
|
|
216
|
+
export const useShouldNestedElementRender: () => {
|
|
217
|
+
shouldRender: boolean;
|
|
218
|
+
};
|
|
219
|
+
|
|
220
|
+
// @public (undocumented)
|
|
221
|
+
export const VAR_SCROLL_INDICATOR_COLOR = "--ds-menu-scroll-indicator-color";
|
|
222
|
+
|
|
223
|
+
// @public (undocumented)
|
|
224
|
+
export const VAR_SEPARATOR_COLOR = "--ds-menu-seperator-color";
|
|
225
|
+
|
|
226
|
+
// (No @packageDocumentation comment for this package)
|
|
227
|
+
|
|
228
|
+
```
|