fix(*): deprecate EnvironmentContext type in favor of UseEnvironmentC…

…ontext
chakra-ui · Nov 29, 2024 · 860e3c8 · 860e3c8
1 parent e3affbb
commit 860e3c8
Show file tree

Hide file tree

Showing 20 changed files with 46 additions and 24 deletions.
diff --git a/packages/react/CHANGELOG.md b/packages/react/CHANGELOG.md
@@ -10,9 +10,14 @@ description: All notable changes will be documented in this file.
 
 - **ColorPicker**: Added support for `invalid` and `openAutoFocus` props.
 
+- ### Changed
+
+- **Environment**: Deprecated `EnvironmentContext` in favor of `UseEnvironmentContext`.
+
 ### Fixed
 
 - **Presence, Collapsible**: Resolved a potential memory leak occurring after component unmount.
+- **Environment**: Exported `EnvironmentContext`
 
 ## [4.4.4] - 2024-11-18
 

diff --git a/packages/react/src/providers/environment/examples/basic.tsx b/packages/react/src/providers/environment/examples/basic.tsx
@@ -1,5 +1,5 @@
+import { EnvironmentProvider } from '@ark-ui/react/environment'
 import Frame from 'react-frame-component'
-import { EnvironmentProvider } from '../'
 import { Usage } from './usage'
 
 export const Basic = () => {

diff --git a/packages/react/src/providers/environment/examples/setup.tsx b/packages/react/src/providers/environment/examples/setup.tsx
@@ -1,5 +1,5 @@
+import { EnvironmentProvider } from '@ark-ui/react/environment'
 import Frame from 'react-frame-component'
-import { EnvironmentProvider } from '../'
 
 export const App = () => {
   return (

diff --git a/packages/react/src/providers/environment/examples/shadow-root.tsx b/packages/react/src/providers/environment/examples/shadow-root.tsx
@@ -1,7 +1,6 @@
+import { EnvironmentProvider, useEnvironmentContext } from '@ark-ui/react/environment'
+import { Portal } from '@ark-ui/react/portal'
 import { useEffect, useState } from 'react'
-import { EnvironmentProvider, useEnvironmentContext } from '../'
-import { Portal } from '../../../components'
-import { Basic } from '../../../components/tooltip/examples/basic'
 
 export const ShadowRoot = () => {
   const [ref, setRef] = useState<HTMLDivElement | null>(null)
@@ -28,7 +27,6 @@ const PrintEnvironment = () => {
   return (
     <Portal>
       <pre>{JSON.stringify(getRootNode(), null, 2)}</pre>
-      <Basic />
     </Portal>
   )
 }
diff --git a/packages/react/src/providers/environment/examples/usage.tsx b/packages/react/src/providers/environment/examples/usage.tsx
@@ -1,4 +1,4 @@
-import { useEnvironmentContext } from '../use-environment-context'
+import { useEnvironmentContext } from '@ark-ui/react/environment'
 
 export const Usage = () => {
   const { getRootNode } = useEnvironmentContext()

diff --git a/packages/react/src/providers/environment/index.ts b/packages/react/src/providers/environment/index.ts
@@ -1,6 +1,10 @@
 export { EnvironmentProvider, type EnvironmentProviderProps } from './environment-provider'
 export {
   useEnvironmentContext,
-  type EnvironmentContext,
+  type UseEnvironmentContext,
+  /**
+   * @deprecated Use `UseEnvironmentContext` instead.
+   */
+  type UseEnvironmentContext as EnvironmentContext,
   type RootNode,
 } from './use-environment-context'
diff --git a/packages/react/src/providers/environment/use-environment-context.ts b/packages/react/src/providers/environment/use-environment-context.ts
@@ -2,7 +2,7 @@ import { createContext } from '../../utils/create-context'
 
 export type RootNode = ShadowRoot | Document | Node
 
-export interface EnvironmentContext {
+export interface UseEnvironmentContext {
   /**
    * The root node of the application.
    * This is used to determine the window and document objects.
@@ -19,7 +19,7 @@ export interface EnvironmentContext {
 }
 
 export const [EnvironmentContextProvider, useEnvironmentContext] =
-  createContext<EnvironmentContext>({
+  createContext<UseEnvironmentContext>({
     name: 'EnvironmentContext',
     hookName: 'useEnvironmentContext',
     providerName: '<EnvironmentProvider />',

diff --git a/packages/solid/CHANGELOG.md b/packages/solid/CHANGELOG.md
@@ -10,6 +10,10 @@ description: All notable changes will be documented in this file.
 
 - **ColorPicker**: Added support for `invalid` and `openAutoFocus` props.
 
+- ### Changed
+
+- **Environment**: Deprecated `EnvironmentContext` in favor of `UseEnvironmentContext`.
+
 ### Fixed
 
 - **Presence, Collapsible**: Resolved a potential memory leak occurring after component unmount.

diff --git a/packages/solid/src/providers/environment/examples/basic.tsx b/packages/solid/src/providers/environment/examples/basic.tsx
@@ -1,4 +1,4 @@
-import { EnvironmentProvider } from '../..'
+import { EnvironmentProvider } from '@ark-ui/solid/environment'
 import { Usage } from './usage'
 
 export const Basic = () => (

diff --git a/packages/solid/src/providers/environment/examples/setup.tsx b/packages/solid/src/providers/environment/examples/setup.tsx
@@ -1,4 +1,4 @@
-import { EnvironmentProvider } from '../..'
+import { EnvironmentProvider } from '@ark-ui/solid/environment'
 
 export const App = () => {
   return (

diff --git a/packages/solid/src/providers/environment/index.tsx b/packages/solid/src/providers/environment/index.tsx
@@ -1,6 +1,10 @@
 export { EnvironmentProvider, type EnvironmentProviderProps } from './environment-provider'
 export {
   useEnvironmentContext,
-  type EnvironmentContext,
+  /**
+   * @deprecated Use `UseEnvironmentContext` instead.
+   */
+  type UseEnvironmentContext as EnvironmentContext,
   type RootNode,
+  type UseEnvironmentContext,
 } from './use-environment-context'
diff --git a/packages/solid/src/providers/environment/use-environment-context.ts b/packages/solid/src/providers/environment/use-environment-context.ts
@@ -3,7 +3,7 @@ import { createContext } from '../../utils/create-context'
 
 export type RootNode = ShadowRoot | Document | Node
 
-export interface EnvironmentContext {
+export interface UseEnvironmentContext {
   /**
    * The root node of the application.
    * This is used to determine the window and document objects.
@@ -23,7 +23,7 @@ export interface EnvironmentContext {
 }
 
 export const [EnvironmentContextProvider, useEnvironmentContext] = createContext<
-  Accessor<EnvironmentContext>
+  Accessor<UseEnvironmentContext>
 >({
   hookName: 'useEnvironmentContext',
   providerName: '<EnvironmentProvider />',

diff --git a/packages/svelte/src/lib/providers/environment/index.ts b/packages/svelte/src/lib/providers/environment/index.ts
@@ -4,6 +4,6 @@ export {
 } from './environment-provider.svelte'
 export {
   useEnvironmentContext,
-  type EnvironmentContext,
+  type UseEnvironmentContext,
   type RootNode,
 } from './use-environment-context'
diff --git a/packages/svelte/src/lib/providers/environment/use-environment-context.ts b/packages/svelte/src/lib/providers/environment/use-environment-context.ts
@@ -2,7 +2,7 @@ import { createContext } from '$lib/utils/create-context'
 
 export type RootNode = ShadowRoot | Document | Node
 
-export interface EnvironmentContext {
+export interface UseEnvironmentContext {
   /**
    * The root node of the application.
    * This is used to determine the window and document objects.
@@ -22,7 +22,7 @@ export interface EnvironmentContext {
 }
 
 export const [EnvironmentContextProvider, useEnvironmentContext] =
-  createContext<EnvironmentContext>({
+  createContext<UseEnvironmentContext>({
     key: 'EnvironmentContext',
     defaultValue: {
       getRootNode: () => document,

diff --git a/packages/vue/CHANGELOG.md b/packages/vue/CHANGELOG.md
@@ -10,6 +10,10 @@ description: All notable changes will be documented in this file.
 
 - **ColorPicker**: Added support for `invalid` and `openAutoFocus` props.
 
+- ### Changed
+
+- **Environment**: Deprecated `EnvironmentContext` in favor of `UseEnvironmentContext`.
+
 ### Fixed
 
 - **Presence, Collapsible**: Resolved a potential memory leak occurring after component unmount.

diff --git a/packages/vue/src/providers/environment/examples/basic.vue b/packages/vue/src/providers/environment/examples/basic.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { EnvironmentProvider } from '..'
+import { EnvironmentProvider } from '@ark-ui/vue/environment'
 import Usage from './usage.vue'
 </script>
 

diff --git a/packages/vue/src/providers/environment/examples/setup.vue b/packages/vue/src/providers/environment/examples/setup.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { EnvironmentProvider } from '../'
+import { EnvironmentProvider } from '@ark-ui/vue/environment'
 </script>
 
 <template>

diff --git a/packages/vue/src/providers/environment/examples/usage.vue b/packages/vue/src/providers/environment/examples/usage.vue
@@ -1,5 +1,5 @@
 <script setup lang="ts">
-import { useEnvironmentContext } from '../'
+import { useEnvironmentContext } from '@ark-ui/vue/environment'
 
 const environment = useEnvironmentContext()
 </script>

diff --git a/packages/vue/src/providers/environment/index.ts b/packages/vue/src/providers/environment/index.ts
@@ -4,6 +4,9 @@ export {
 } from './environment-provider.vue'
 export {
   useEnvironmentContext,
-  type EnvironmentContext,
+  /**
+   * @deprecated Use `UseEnvironmentContext` instead.
+   */
+  type UseEnvironmentContext as EnvironmentContext,
   type RootNode,
 } from './use-environment-context'
diff --git a/packages/vue/src/providers/environment/use-environment-context.ts b/packages/vue/src/providers/environment/use-environment-context.ts
@@ -3,7 +3,7 @@ import { createContext } from '../../utils'
 
 export type RootNode = ShadowRoot | Document | Node
 
-export interface EnvironmentContext {
+export interface UseEnvironmentContext {
   /**
    * The root node of the application.
    * This is used to determine the window and document objects.
@@ -20,4 +20,4 @@ export interface EnvironmentContext {
 }
 
 export const [EnvironmentContextProvider, useEnvironmentContext] =
-  createContext<ComputedRef<EnvironmentContext> | null>('EnvironmentContext')
+  createContext<ComputedRef<UseEnvironmentContext> | null>('EnvironmentContext')