{"id":31923059,"url":"https://github.com/rocketchat/rn-user-defaults","last_synced_at":"2025-10-13T23:43:47.958Z","repository":{"id":74702508,"uuid":"191455559","full_name":"RocketChat/rn-user-defaults","owner":"RocketChat","description":"Use UserDefaults (iOS) and SharedPreferences (AndroidOS) with React Native, this can help you to share credentials between apps or between app and extensions on iOS.","archived":false,"fork":false,"pushed_at":"2020-09-30T12:51:14.000Z","size":79,"stargazers_count":13,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-22T14:37:12.076Z","etag":null,"topics":["android","context","ios","react-native","sharedpreferences","userdefaults"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RocketChat.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-11T21:52:42.000Z","updated_at":"2023-11-27T09:30:29.000Z","dependencies_parsed_at":null,"dependency_job_id":"fb58e0a2-0582-419c-b2ce-c8f20b2bdc9e","html_url":"https://github.com/RocketChat/rn-user-defaults","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/RocketChat/rn-user-defaults","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frn-user-defaults","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frn-user-defaults/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frn-user-defaults/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frn-user-defaults/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RocketChat","download_url":"https://codeload.github.com/RocketChat/rn-user-defaults/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RocketChat%2Frn-user-defaults/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017232,"owners_count":26086016,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","context","ios","react-native","sharedpreferences","userdefaults"],"created_at":"2025-10-13T23:43:40.796Z","updated_at":"2025-10-13T23:43:47.950Z","avatar_url":"https://github.com/RocketChat.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# rn-user-defaults\n\nUse `UserDefaults` (iOS) and `SharedPreferences` (AndroidOS) with React Native, this can help you to share credentials between apps or between app and extensions on iOS.\n\n## Getting started\n\n`$ npm install rn-user-defaults --save`\n\nor \n\n`$ yarn add rn-user-defaults`\n\nIf you are using `React Native 0.60.+` go to the folder **your-project/ios** and run `pod install`, and you're done. \n\nIf not, use one of the following method to link.\n\n### Mostly automatic with `react-native link`\n\nIf you are using `React Native \u003c= 0.59.X`, link the native project:\n\n`$ react-native link rn-user-defaults`\n\n### Manual installation\n\nIf you are using `React Native \u003c= 0.59.X` and `react-native link` don't work for you:\n\n#### iOS\n\n1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`\n2. Go to `node_modules` ➜ `rn-user-defaults` and add `RNUserDefaults.xcodeproj`\n3. In XCode, in the project navigator, select your project. Add `libRNUserDefaults.a` to your project's `Build Phases` ➜ `Link Binary With Libraries`\n4. Run your project (`Cmd+R`)\u003c\n\n#### Android\n\n- Edit `android/settings.gradle` and add the following\n\n```gradle\ninclude ':app', ':rn-user-defaults'\n\nproject(':rn-user-defaults').projectDir = new File(rootProject.projectDir, '../node_modules/rn-user-defaults/android')\n```\n\n- Edit `android/app/build.gradle` and add the following line before the react section in dependencies\n\n```gradle\ndependencies {\n    ...\n    implementation project(':rn-user-defaults')\n    implementation \"com.facebook.react:react-native:+\"\n}\n```\n\n- Add these lines to `MainApplication.java`\n\n```java\n...\nimport chat.rocket.userdefaults;\n...\n@Override\nprotected List\u003cReactPackage\u003e getPackages() {\n    @SuppressWarnings(\"UnnecessaryLocalVariable\")\n    List\u003cReactPackage\u003e packages = new PackageList(this).getPackages();\n    ...\n    packages.add(new RNUserDefaultsPackage());\n    return packages;\n}\n```\n\n## Usage\n\n```js\nimport RNUserDefaults from 'rn-user-defaults';\n\nRNUserDefaults.set('key', 'value').then(function() {console.log('done')}); // done\nRNUserDefaults.get('key').then(function(value) {console.log(value)}); // value\nRNUserDefaults.setObjectForKey('objKey', { dog: 1 }).then(function() {console.log('done')}); // done\nRNUserDefaults.objectForKey('objKey').then(function(value) {console.log(value)}); // { dog: 1 }\n```\n\n## Static methods\n\nNow you can use static methods to access current SharedPreferences or UserDefaults classes on native modules.\n\n#### Android\n\n```java\nimport android.content.SharedPreferences;\nimport chat.rocket.userdefaults.RNUserDefaultsModule;\n\nSharedPreferences sharedPreferences = RNUserDefaultsModule.getPreferences();\nString exampleString = sharedPreferences.getString(\"STRING_KEY\", \"\");\n\nSharedPreferences sharedPreferences1 = RNUserDefaultsModule.getPreferences(reactApplicationContext);\nString exampleString1 = sharedPreferences1.getString(\"STRING_KEY\", \"\");\n\nSharedPreferences sharedPreferences2 = RNUserDefaultsModule.getPreferences(reactApplicationContext, contextName, preferencesName);\nString exampleString2 = sharedPreferences2.getString(\"STRING_KEY\", \"\");\n```\n\n#### iOS\n```objective-c\n#import \"RNUserDefaults.h\"\n\nNSDictionary *exampleObject = [[RNUserDefaults getDefaultUser] objectForKey:@\"OBJECT_KEY\"];\n```\n\n### Set a AppGroup on iOS\nAdd the follow code to your Info.plist\n```\n\u003ckey\u003eAppGroup\u003c/key\u003e\n\u003cstring\u003eyour.group.name\u003c/string\u003e\n```\n\n## API\n\n```haxe\nfunction get(key:String):Promise\u003cString\u003e;\nfunction set(key:String, value:String):Promise\u003cVoid\u003e;\nfunction setObjectForKey(key:String, value:Object):Promise\u003cVoid\u003e;\nfunction objectForKey(key:String):Promise\u003cObject\u003e;\nfunction clear(key:String):Promise\u003cVoid\u003e;\nfunction clearAll():Promise\u003cVoid\u003e;\n\n/**\n  Android = getReactApplicationContext().getSharedPreferences(name, Context.MODE_PRIVATE);\n**/\nfunction setName(name:String):Promise\u003cVoid\u003e;\n\n/**\n  You can set a context to you sharedPreferences (Android)\n**/\nfunction setPackageContext(context:String):Promise\u003cVoid\u003e;\n```\n\n## License\n\n```\nMIT License\n\nCopyright (c) 2019 Djorkaeff Alexandre\n```\n\nSee the full [licence file](https://github.com/RocketChat/rn-user-defaults/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frn-user-defaults","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frocketchat%2Frn-user-defaults","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frocketchat%2Frn-user-defaults/lists"}