-
Notifications
You must be signed in to change notification settings - Fork 24k
/
NativeComponentRegistry.js
164 lines (148 loc) · 4.92 KB
/
NativeComponentRegistry.js
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow strict-local
* @format
*/
import type {
HostComponent,
PartialViewConfig,
} from '../Renderer/shims/ReactNativeTypes';
import getNativeComponentAttributes from '../ReactNative/getNativeComponentAttributes';
import UIManager from '../ReactNative/UIManager';
import * as ReactNativeViewConfigRegistry from '../Renderer/shims/ReactNativeViewConfigRegistry';
import verifyComponentAttributeEquivalence from '../Utilities/verifyComponentAttributeEquivalence';
import * as StaticViewConfigValidator from './StaticViewConfigValidator';
import {createViewConfig} from './ViewConfig';
import invariant from 'invariant';
import * as React from 'react';
let getRuntimeConfig;
/**
* Configures a function that is called to determine whether a given component
* should be registered using reflection of the native component at runtime.
*
* The provider should return null if the native component is unavailable in
* the current environment.
*/
export function setRuntimeConfigProvider(
runtimeConfigProvider: (name: string) => ?{
native: boolean,
strict: boolean,
verify: boolean,
},
): void {
if (getRuntimeConfig === undefined) {
getRuntimeConfig = runtimeConfigProvider;
}
}
/**
* Gets a `NativeComponent` that can be rendered by React Native.
*
* The supplied `viewConfigProvider` may or may not be invoked and utilized,
* depending on how `setRuntimeConfigProvider` is configured.
*/
export function get<Config>(
name: string,
viewConfigProvider: () => PartialViewConfig,
): HostComponent<Config> {
ReactNativeViewConfigRegistry.register(name, () => {
const {native, strict, verify} = getRuntimeConfig?.(name) ?? {
native: !global.RN$Bridgeless,
strict: false,
verify: false,
};
let viewConfig;
if (native) {
viewConfig =
getNativeComponentAttributes(name) ??
createViewConfig(viewConfigProvider());
} else {
viewConfig =
createViewConfig(viewConfigProvider()) ??
getNativeComponentAttributes(name);
}
invariant(
viewConfig != null,
'NativeComponentRegistry.get: both static and native view config are missing for native component "%s".',
name,
);
if (verify) {
const nativeViewConfig = native
? viewConfig
: getNativeComponentAttributes(name);
const staticViewConfig = native
? createViewConfig(viewConfigProvider())
: viewConfig;
if (strict) {
const validationOutput = StaticViewConfigValidator.validate(
name,
nativeViewConfig,
staticViewConfig,
);
if (validationOutput.type === 'invalid') {
console.error(
StaticViewConfigValidator.stringifyValidationResult(
name,
validationOutput,
),
);
}
} else {
verifyComponentAttributeEquivalence(nativeViewConfig, staticViewConfig);
}
}
return viewConfig;
});
// $FlowFixMe[incompatible-return] `NativeComponent` is actually string!
return name;
}
/**
* Same as `NativeComponentRegistry.get(...)`, except this will check either
* the `setRuntimeConfigProvider` configuration or use native reflection (slow)
* to determine whether this native component is available.
*
* If the native component is not available, a stub component is returned. Note
* that the return value of this is not `HostComponent` because the returned
* component instance is not guaranteed to have native methods.
*/
export function getWithFallback_DEPRECATED<Config>(
name: string,
viewConfigProvider: () => PartialViewConfig,
): React.AbstractComponent<Config> {
if (getRuntimeConfig == null) {
// `getRuntimeConfig == null` when static view configs are disabled
// If `setRuntimeConfigProvider` is not configured, use native reflection.
if (hasNativeViewConfig(name)) {
return get<Config>(name, viewConfigProvider);
}
} else {
// If there is no runtime config, then the native component is unavailable.
if (getRuntimeConfig(name) != null) {
return get<Config>(name, viewConfigProvider);
}
}
const FallbackNativeComponent = function (props: Config): React.Node {
return null;
};
FallbackNativeComponent.displayName = `Fallback(${name})`;
return FallbackNativeComponent;
}
function hasNativeViewConfig(name: string): boolean {
invariant(getRuntimeConfig == null, 'Unexpected invocation!');
return UIManager.getViewManagerConfig(name) != null;
}
/**
* Unstable API. Do not use!
*
* This method returns if there is a StaticViewConfig registered for the
* component name received as a parameter.
*/
export function unstable_hasStaticViewConfig(name: string): boolean {
const {native} = getRuntimeConfig?.(name) ?? {
native: true,
};
return !native;
}