Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeferraro/react-native-cookies
Cookie manager for React Native
https://github.com/joeferraro/react-native-cookies
android cookies ios mobile react react-native
Last synced: 11 days ago
JSON representation
Cookie manager for React Native
- Host: GitHub
- URL: https://github.com/joeferraro/react-native-cookies
- Owner: joeferraro
- License: mit
- Archived: true
- Created: 2015-05-28T04:33:08.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-01-23T18:47:22.000Z (almost 5 years ago)
- Last Synced: 2024-02-12T17:04:36.057Z (9 months ago)
- Topics: android, cookies, ios, mobile, react, react-native
- Language: Objective-C
- Size: 114 KB
- Stars: 789
- Watchers: 21
- Forks: 317
- Open Issues: 85
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-react-native-native-modules - react-native-cookies ★442
README
## react-native-cookies
Cookie manager for react native.
[](https://badge.fury.io/js/react-native-cookies)
[](https://www.npmjs.com/package/react-native-cookies)
[](https://raw.githubusercontent.com/joeferraro/react-native-cookies/master/LICENSE.md)
## This project has moved
This project has been moved to the [React Native Community](https://github.com/react-native-community/react-native-cookies).
### Installation
```
yarn add react-native-cookies
```
### Linking
#### Automatic (recommended)
```
react-native link react-native-cookies
```
#### Manual
If automatic linking does not work, you can manually link this library by following the instructions below:
##### iOS
1. Open your project in Xcode, right click on `Libraries` and click `Add
Files to "Your Project Name"` Look under `node_modules/react-native-cookies/ios` and add `RNCookieManagerIOS.xcodeproj`.
2. Add `libRNCookieManagerIOS.a` to `Build Phases -> Link Binary With Libraries.
3. Clean and rebuild your project
##### Android
Run `react-native link` to link the react-native-cookies library.
Or if you have trouble, make the following additions to the given files manually:
**android/settings.gradle**
```gradle
include ':react-native-cookies'
project(':react-native-cookies').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-cookies/android')
```
**android/app/build.gradle**
```gradle
dependencies {
...
compile project(':react-native-cookies')
}
```
**MainApplication.java**
On top, where imports are:
```java
import com.psykar.cookiemanager.CookieManagerPackage;
```
Add the `CookieManagerPackage` class to your list of exported packages.
```java
@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage(),
new CookieManagerPackage()
);
}
```
### Usage
```javascript
import CookieManager from 'react-native-cookies';
// set a cookie (IOS ONLY)
CookieManager.set({
name: 'myCookie',
value: 'myValue',
domain: 'some domain',
origin: 'some origin',
path: '/',
version: '1',
expiration: '2015-05-30T12:30:00.00-05:00'
}).then((res) => {
console.log('CookieManager.set =>', res);
});
// Set cookies from a response header
// This allows you to put the full string provided by a server's Set-Cookie
// response header directly into the cookie store.
CookieManager.setFromResponse(
'http://example.com',
'user_session=abcdefg; path=/; expires=Thu, 1 Jan 2030 00:00:00 -0000; secure; HttpOnly')
.then((res) => {
// `res` will be true or false depending on success.
console.log('CookieManager.setFromResponse =>', res);
});
// Get cookies as a request header string
CookieManager.get('http://example.com')
.then((res) => {
console.log('CookieManager.get =>', res); // => 'user_session=abcdefg; path=/;'
});
// list cookies (IOS ONLY)
CookieManager.getAll()
.then((res) => {
console.log('CookieManager.getAll =>', res);
});
// clear cookies
CookieManager.clearAll()
.then((res) => {
console.log('CookieManager.clearAll =>', res);
});
// clear a specific cookie by its name (IOS ONLY)
CookieManager.clearByName('cookie_name')
.then((res) => {
console.log('CookieManager.clearByName =>', res);
});
```
#### WebKit-Support (iOS only)
React Native comes with a WebView component, which uses UIWebView on iOS. Introduced in iOS 8 Apple implemented the WebKit-Support with all the performance boost.
To use this it's required to use a special implementation of the WebView component (e.g. [react-native-wkwebview](https://github.com/CRAlpha/react-native-wkwebview)).
This special implementation of the WebView component stores the cookies __not__ in `NSHTTPCookieStorage` anymore. The new cookie-storage is `WKHTTPCookieStore` and implementes a differnt interface.
To use this _CookieManager_ with WebKit-Support we extended the interface with the attribute `useWebKit` (a boolean value, default: `FASLE`) for the following methods:
|Method|WebKit-Support|Method-Signature|
|---|---|---|
|getAll| Yes | `CookieManager.getAll(useWebKit:boolean)` |
|clearAll| Yes | `CookieManager.clearAll(useWebKit:boolean)` |
|get| Yes | `CookieManager.get(url:string, useWebKit:boolean)` |
|set| Yes | `CookieManager.set(cookie:object, useWebKit:boolean)` |
##### Usage
```javascript
import CookieManager from 'react-native-cookies';
const useWebKit = true;
// list cookies (IOS ONLY)
CookieManager.getAll(useWebKit)
.then((res) => {
console.log('CookieManager.getAll from webkit-view =>', res);
});
// clear cookies
CookieManager.clearAll(useWebKit)
.then((res) => {
console.log('CookieManager.clearAll from webkit-view =>', res);
});
// Get cookies as a request header string
CookieManager.get('http://example.com', useWebKit)
.then((res) => {
console.log('CookieManager.get from webkit-view =>', res);
// => 'user_session=abcdefg; path=/;'
});
// set a cookie (IOS ONLY)
const newCookie: = {
name: 'myCookie',
value: 'myValue',
domain: 'some domain',
origin: 'some origin',
path: '/',
version: '1',
expiration: '2015-05-30T12:30:00.00-05:00'
};
CookieManager.set(newCookie, useWebKit)
.then((res) => {
console.log('CookieManager.set from webkit-view =>', res);
});
```
### TODO
- Proper `getAll` dictionary by domain
- Proper error handling
- Anything else?
PR's welcome!