Additional user context

README.md

@@ -39,6 +39,21 @@ ReactDOM.render(
 | onFlagsChange    | function  | false    | Handler for flag change      |
 | loadingComponent | Component | false    | Loading component / string   |
 
+The `user` object can have any of the following properties:
+
+| Prop             | Type      | Description                                   |
+|------------------|-----------|-----------------------------------------------|
+| key              | String    | A unique string identifying the user context  |
+| name             | String    | The name given to the user context            |
+| firstName        | String    | User's first name                             |
+| lastName         | String    | User's last name                              |
+| email            | String    | User's email address                          |
+| avatar           | String    | URL to user's avatar image                    |
+| ip               | String    | IP address of user                            |
+| country          | String    | User country                                  |
+| anonymous        | Boolean   | If true, hide the context in LaunchDarkly     |
+| custom           | Object    | Custom metadata of the user                   |
+
 ### Flags
 All `Flags` components get the _ldClient_ instance thanks to the `FlagsProvider` component.
 

package.json

@@ -1,13 +1,16 @@
 {
   "name": "@lectra/ld-react-feature-flags",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Integrate Launch Darkly in your React app in a breeze",
   "contributors": [
     {
       "name": "Guillaume Dumora"
     },
     {
       "name": "Romain Durand Saint Omer"
+    },
+    {
+      "name": "Craig Bailey"
     }
   ],
   "license": "MIT",

src/FlagsProvider.js

@@ -9,6 +9,14 @@ export default class FlagsProvider extends Component {
     children: PropTypes.any,
     user: PropTypes.shape({
       key: PropTypes.string,
+      name: PropTypes.string,
+      firstName: PropTypes.string,
+      lastName: PropTypes.string,
+      email: PropTypes.string,
+      avatar: PropTypes.string,
+      ip: PropTypes.string,
+      country: PropTypes.string,
+      anonymous: PropTypes.bool,
       custom: PropTypes.object
     }).isRequired,
     clientkey: PropTypes.string.isRequired,
@@ -37,8 +45,7 @@ export default class FlagsProvider extends Component {
       clientkey,
       {
         kind: 'user',
-        key: user.key,
-        ...user.custom
+        ...user
       },
       bootstrap
     );