-
Notifications
You must be signed in to change notification settings - Fork 0
/
SchemaMetadataContext.tsx
59 lines (51 loc) · 1.93 KB
/
SchemaMetadataContext.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
/** @packageDocumentation
* @module Core
*/
import { createContext, PropsWithChildren, useContext, useEffect, useState } from "react";
import { IModelConnection } from "@itwin/core-frontend";
import { SchemaContext } from "@itwin/ecschema-metadata";
/**
* Context that stores metadata related to schemas.
* @beta
*/
export interface SchemaMetadataContext {
/** Schema context for schemas lookup. */
schemaContext: SchemaContext;
}
const schemaMetadataContext = createContext<SchemaMetadataContext | undefined>(undefined);
/**
* Props for [[SchemaMetadataContextProvider]]
* @beta
*/
export interface SchemaMetadataContextProviderProps {
/** iModel to pull schemas from. */
imodel: IModelConnection;
/** Callback that provides schema context for supplied imodel. */
schemaContextProvider: (imodel: IModelConnection) => SchemaContext;
}
/**
* Provides schema metadata to components that work with schemas.
* @beta
*/
export function SchemaMetadataContextProvider({ schemaContextProvider, imodel, children }: PropsWithChildren<SchemaMetadataContextProviderProps>) {
const [state, setState] = useState<SchemaMetadataContext>(() => ({
schemaContext: schemaContextProvider(imodel),
}));
useEffect(() => {
setState({
schemaContext: schemaContextProvider(imodel),
});
}, [imodel, schemaContextProvider]);
return <schemaMetadataContext.Provider value={state}>{children}</schemaMetadataContext.Provider>;
}
/**
* Returns context provided by [[SchemaMetadataContextProvider]].
* @beta
*/
export function useSchemaMetadataContext() {
return useContext(schemaMetadataContext);
}