@atlaskit/app-provider 0.4.0 → 1.0.0
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/constellation/index/examples.mdx +1 -1
- package/package.json +3 -4
- package/tmp/api-report-tmp.d.ts +0 -57
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @atlaskit/app-provider
|
|
2
2
|
|
|
3
|
+
## 1.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [#69683](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/69683) [`203c0f3c8b03`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/203c0f3c8b03) - Stable v1 release of app provider
|
|
8
|
+
|
|
3
9
|
## 0.4.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
|
@@ -32,7 +32,7 @@ The `useTheme` hook can be used to get the active themes. The `useSetTheme` hook
|
|
|
32
32
|
|
|
33
33
|
The `routerLinkComponent` prop provides support for configuring router links within Design System components.
|
|
34
34
|
|
|
35
|
-
Support for this is limited as Design System components are being updated, starting with
|
|
35
|
+
Support for this is limited as Design System components are being updated, starting with [Button](/components/button/button-new/examples).
|
|
36
36
|
|
|
37
37
|
This example shows how links can be configured to utilize the router link component supplied by [React Resource Router](https://github.com/atlassian-labs/react-resource-router), however any routing library can be used.
|
|
38
38
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/app-provider",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "A top level provider for the Design System.",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
"name": "App provider",
|
|
16
16
|
"category": "Components",
|
|
17
17
|
"status": {
|
|
18
|
-
"type": "
|
|
18
|
+
"type": "beta"
|
|
19
19
|
}
|
|
20
20
|
}
|
|
21
21
|
},
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
".": "./src/index.tsx"
|
|
39
39
|
},
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"@atlaskit/tokens": "^1.
|
|
41
|
+
"@atlaskit/tokens": "^1.35.0",
|
|
42
42
|
"@babel/runtime": "^7.0.0",
|
|
43
43
|
"bind-event-listener": "^2.1.1"
|
|
44
44
|
},
|
|
@@ -49,7 +49,6 @@
|
|
|
49
49
|
"@af/visual-regression": "*",
|
|
50
50
|
"@atlaskit/ssr": "*",
|
|
51
51
|
"@atlaskit/visual-regression": "*",
|
|
52
|
-
"@atlaskit/webdriver-runner": "*",
|
|
53
52
|
"@atlassian/atlassian-frontend-prettier-config-1.0.0": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.0",
|
|
54
53
|
"@testing-library/react": "^12.1.5",
|
|
55
54
|
"@testing-library/react-hooks": "^8.0.1",
|
package/tmp/api-report-tmp.d.ts
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/app-provider"
|
|
2
|
-
|
|
3
|
-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
-
|
|
5
|
-
```ts
|
|
6
|
-
|
|
7
|
-
import { default as React_2 } from 'react';
|
|
8
|
-
import { ThemeState } from '@atlaskit/tokens';
|
|
9
|
-
|
|
10
|
-
// @public
|
|
11
|
-
function AppProvider({ children, defaultColorMode, defaultTheme, routerLinkComponent, }: AppProviderProps): JSX.Element;
|
|
12
|
-
export default AppProvider;
|
|
13
|
-
|
|
14
|
-
// @public (undocumented)
|
|
15
|
-
interface AppProviderProps {
|
|
16
|
-
children: React_2.ReactNode;
|
|
17
|
-
defaultColorMode?: ColorMode;
|
|
18
|
-
defaultTheme?: Partial<Theme>;
|
|
19
|
-
routerLinkComponent?: RouterLinkComponent<any>;
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
// @public (undocumented)
|
|
23
|
-
type ColorMode = 'auto' | 'dark' | 'light';
|
|
24
|
-
|
|
25
|
-
// @public (undocumented)
|
|
26
|
-
type ReconciledColorMode = Exclude<ColorMode, 'auto'>;
|
|
27
|
-
|
|
28
|
-
// @public (undocumented)
|
|
29
|
-
type RouterLinkComponent<RouterLinkConfig extends Record<string, any> = never> = React_2.ForwardRefExoticComponent<RouterLinkComponentProps<RouterLinkConfig> & React_2.RefAttributes<HTMLAnchorElement>>;
|
|
30
|
-
|
|
31
|
-
// @public (undocumented)
|
|
32
|
-
export type RouterLinkComponentProps<RouterLinkConfig extends Record<string, any> = never> = {
|
|
33
|
-
href: RouterLinkConfig | string;
|
|
34
|
-
children: React_2.ReactNode;
|
|
35
|
-
};
|
|
36
|
-
|
|
37
|
-
// @public (undocumented)
|
|
38
|
-
type Theme = Omit<ThemeState, 'colorMode' | 'contrastMode'>;
|
|
39
|
-
|
|
40
|
-
// @public
|
|
41
|
-
export function useColorMode(): ReconciledColorMode;
|
|
42
|
-
|
|
43
|
-
// @public
|
|
44
|
-
export const useRouterLink: <RouterLinkConfig extends Record<string, any> = never>() => RouterLinkComponent<RouterLinkConfig> | undefined;
|
|
45
|
-
|
|
46
|
-
// @public
|
|
47
|
-
export function useSetColorMode(): (value: ColorMode) => void;
|
|
48
|
-
|
|
49
|
-
// @public
|
|
50
|
-
export function useSetTheme(): (value: Partial<Theme>) => void;
|
|
51
|
-
|
|
52
|
-
// @public
|
|
53
|
-
export function useTheme(): Theme;
|
|
54
|
-
|
|
55
|
-
// (No @packageDocumentation comment for this package)
|
|
56
|
-
|
|
57
|
-
```
|