mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Janic Duplessis
cc068b0551
Summary: I wanted to configure the RN dev menu without having to write native code. This is pretty useful in a greenfield app since it avoids having to write a custom native module for both platforms (and might enable the feature for expo too). This ended up a bit more involved than planned since callbacks can only be called once. I needed to convert the `DevSettings` module to a `NativeEventEmitter` and use events when buttons are clicked. This means creating a JS wrapper for it. Currently it does not export all methods, they can be added in follow ups as needed. ## Changelog [General] [Added] - Export the DevSettings module, add `addMenuItem` method Pull Request resolved: https://github.com/facebook/react-native/pull/25848 Test Plan: Tested in an app using the following code. ```js if (__DEV__) { DevSettings.addMenuItem('Show Dev Screen', () => { dispatchNavigationAction( NavigationActions.navigate({ routeName: 'dev', }), ); }); } ``` Added an example in RN tester  Differential Revision: D17394916 Pulled By: cpojer fbshipit-source-id: f9d2c548b09821c594189d1436a27b97cf5a5737
96 lines
2.6 KiB
Objective-C
96 lines
2.6 KiB
Objective-C
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <React/RCTBridge.h>
|
|
#import <React/RCTDefines.h>
|
|
#import <React/RCTEventEmitter.h>
|
|
|
|
@protocol RCTPackagerClientMethod;
|
|
|
|
/**
|
|
* An abstraction for a key-value store to manage RCTDevSettings behavior.
|
|
* The default implementation persists settings using NSUserDefaults.
|
|
*/
|
|
@protocol RCTDevSettingsDataSource <NSObject>
|
|
|
|
/**
|
|
* Updates the setting with the given key to the given value.
|
|
* How the data source's state changes depends on the implementation.
|
|
*/
|
|
- (void)updateSettingWithValue:(id)value forKey:(NSString *)key;
|
|
|
|
/**
|
|
* Returns the value for the setting with the given key.
|
|
*/
|
|
- (id)settingForKey:(NSString *)key;
|
|
|
|
@end
|
|
|
|
@interface RCTDevSettings : RCTEventEmitter
|
|
|
|
- (instancetype)initWithDataSource:(id<RCTDevSettingsDataSource>)dataSource;
|
|
|
|
@property (nonatomic, readonly) BOOL isHotLoadingAvailable;
|
|
@property (nonatomic, readonly) BOOL isLiveReloadAvailable;
|
|
@property (nonatomic, readonly) BOOL isRemoteDebuggingAvailable;
|
|
@property (nonatomic, readonly) BOOL isNuclideDebuggingAvailable;
|
|
@property (nonatomic, readonly) BOOL isJSCSamplingProfilerAvailable;
|
|
|
|
/**
|
|
* Whether the bridge is connected to a remote JS executor.
|
|
*/
|
|
@property (nonatomic, assign) BOOL isDebuggingRemotely;
|
|
|
|
/*
|
|
* Whether shaking will show RCTDevMenu. The menu is enabled by default if RCT_DEV=1, but
|
|
* you may wish to disable it so that you can provide your own shake handler.
|
|
*/
|
|
@property (nonatomic, assign) BOOL isShakeToShowDevMenuEnabled;
|
|
|
|
/**
|
|
* Whether performance profiling is enabled.
|
|
*/
|
|
@property (nonatomic, assign, setter=setProfilingEnabled:) BOOL isProfilingEnabled;
|
|
|
|
/**
|
|
* Whether hot loading is enabled.
|
|
*/
|
|
@property (nonatomic, assign, setter=setHotLoadingEnabled:) BOOL isHotLoadingEnabled;
|
|
|
|
/**
|
|
* Toggle the element inspector.
|
|
*/
|
|
- (void)toggleElementInspector;
|
|
|
|
/**
|
|
* Enables starting of profiling sampler on launch
|
|
*/
|
|
@property (nonatomic, assign) BOOL startSamplingProfilerOnLaunch;
|
|
|
|
/**
|
|
* Whether the element inspector is visible.
|
|
*/
|
|
@property (nonatomic, readonly) BOOL isElementInspectorShown;
|
|
|
|
/**
|
|
* Whether the performance monitor is visible.
|
|
*/
|
|
@property (nonatomic, assign) BOOL isPerfMonitorShown;
|
|
|
|
#if RCT_DEV_MENU
|
|
- (void)addHandler:(id<RCTPackagerClientMethod>)handler
|
|
forPackagerMethod:(NSString *)name __deprecated_msg("Use RCTPackagerConnection directly instead");
|
|
#endif
|
|
|
|
@end
|
|
|
|
@interface RCTBridge (RCTDevSettings)
|
|
|
|
@property (nonatomic, readonly) RCTDevSettings *devSettings;
|
|
|
|
@end
|