Skip to content

Commit 64dd370

Browse files
authored
Exporting useProvider from RSP monopackage (#2769)
* exporting useProvider from monopackage * making provider type/useProvider descriptions clearer
1 parent 7e8a7f6 commit 64dd370

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

packages/@adobe/react-spectrum/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export {Meter} from '@react-spectrum/meter';
3030
export {NumberField} from '@react-spectrum/numberfield';
3131
export {Picker} from '@react-spectrum/picker';
3232
export {ProgressBar, ProgressCircle} from '@react-spectrum/progress';
33-
export {Provider} from '@react-spectrum/provider';
33+
export {Provider, useProvider} from '@react-spectrum/provider';
3434
export {Radio, RadioGroup} from '@react-spectrum/radio';
3535
export {RangeSlider, Slider} from '@react-spectrum/slider';
3636
export {SearchField} from '@react-spectrum/searchfield';

packages/@react-spectrum/provider/src/Provider.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,10 @@ const ProviderWrapper = React.forwardRef(function ProviderWrapper(props: Provide
185185
);
186186
});
187187

188+
/**
189+
* Returns the various settings and styles applied by the nearest parent Provider.
190+
* Properties explicitly set by the nearest parent Provider override those provided by preceeding Providers.
191+
*/
188192
export function useProvider(): ProviderContext {
189193
return useContext(Context);
190194
}

packages/@react-types/provider/src/index.d.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,24 @@ export interface ProviderProps extends ContextProps, DOMProps, StyleProps {
9292
}
9393

9494
export interface ProviderContext extends ContextProps {
95+
/**
96+
* The package version number of the nearest parent Provider.
97+
*/
9598
version: string,
99+
/**
100+
* The theme of the nearest parent Provider.
101+
*/
96102
theme: Theme,
103+
/**
104+
* The color scheme of the nearest parent Provider.
105+
*/
97106
colorScheme: ColorScheme,
107+
/**
108+
* The scale of the nearest parent Provider.
109+
*/
98110
scale: Scale,
111+
/**
112+
* The breakpoints of the nearest parent Provider used for styleProps.
113+
*/
99114
breakpoints: Breakpoints
100115
}

0 commit comments

Comments
 (0)