feat: export useConfig (#6501)

* feat: export useConfig * chore: test & limit exceed --------- Co-authored-by: 二货机器人 <[email protected]>
ant-design · Mar 1, 2024 · 4a43616 · 4a43616
1 parent 8468a08
commit 4a43616
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 3 deletions.
diff --git a/src/components/config-provider/config-provider.tsx b/src/components/config-provider/config-provider.tsx
@@ -5,7 +5,6 @@ import zhCN from '../../locales/zh-CN'
 
 type Config = {
   locale: Locale
-  children?: ReactNode
 }
 
 export const defaultConfigRef: {
@@ -26,7 +25,9 @@ export function getDefaultConfig() {
 
 const ConfigContext = React.createContext<Config | null>(null)
 
-export type ConfigProviderProps = Config
+export type ConfigProviderProps = Config & {
+  children?: ReactNode
+}
 
 export const ConfigProvider: FC<ConfigProviderProps> = props => {
   const { children, ...config } = props

diff --git a/src/components/config-provider/tests/config-provider.test.tsx b/src/components/config-provider/tests/config-provider.test.tsx
@@ -10,6 +10,7 @@ import Form from '../../form'
 import Picker from '../../picker'
 import SearchBar from '../../search-bar'
 import ImageUploader from '../../image-uploader'
+import { useConfig } from '../'
 
 import zhCN from '../../../locales/zh-CN'
 import zhTW from '../../../locales/zh-TW'
@@ -98,4 +99,16 @@ describe('ConfigProvider', () => {
       expect(container).toMatchSnapshot()
     })
   })
+
+  test('useConfig should only has `locale`', () => {
+    let config: ReturnType<typeof useConfig>
+
+    const Demo = () => {
+      config = useConfig()
+      return null
+    }
+    render(<Demo />)
+
+    expect(Object.keys(config!)).toEqual(['locale'])
+  })
 })
diff --git a/src/index.ts b/src/index.ts
@@ -61,7 +61,7 @@ export type {
 } from './components/checkbox'
 export { default as Collapse } from './components/collapse'
 export type { CollapseProps, CollapsePanelProps } from './components/collapse'
-export { default as ConfigProvider } from './components/config-provider'
+export { default as ConfigProvider, useConfig } from './components/config-provider'
 export type { ConfigProviderProps } from './components/config-provider'
 export { default as DatePicker } from './components/date-picker'
 export type { DatePickerProps, DatePickerRef } from './components/date-picker'