Skip to content

Commit 751ab1d

Browse files
authored
Merge pull request auth0#2367 from jeffreylees/lock-docs-config-images
[DO NOT MERGE] Lock docs config images
2 parents 3142a5f + 9c55dfa commit 751ab1d

19 files changed

+71
-37
lines changed

articles/libraries/lock/v10/customization.md

Lines changed: 71 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,13 @@ var options = {
8686
};
8787
```
8888

89-
![](/media/articles/libraries/lock/customization/connections.png)
89+
Examples of `allowedConnections`:
90+
91+
<img width="300" src="/media/articles/libraries/lock/customization/lock-allowedconnections-usernamepassword.png" />
92+
93+
94+
<img width="300" src="/media/articles/libraries/lock/customization/lock-allowedconnections-social.png" />
95+
9096

9197
### autoclose {Boolean}
9298

@@ -146,7 +152,10 @@ var options = {
146152
};
147153
```
148154

149-
![](/media/articles/libraries/lock/customization/gravatar.png)
155+
Default behavior with Gravatar:
156+
157+
<img width="300" src="/media/articles/libraries/lock/customization/lock-avatar.png" />
158+
150159

151160
### closable {Boolean}
152161

@@ -158,7 +167,8 @@ var options = {
158167
};
159168
```
160169

161-
![](/media/articles/libraries/lock/customization/closable.png)
170+
<img width="300" src="/media/articles/libraries/lock/customization/lock-closable.png" />
171+
162172

163173
### container {String}
164174

@@ -185,7 +195,8 @@ This makes the widget appear inline within your `div` instead of in a modal pop-
185195
</script>
186196
```
187197

188-
![](/media/articles/libraries/lock/customization/container.png)
198+
<img width="300" src="/media/articles/libraries/lock/customization/lock-container.png" />
199+
189200

190201
### language {String}:
191202

@@ -195,11 +206,12 @@ Specifies the language of the widget. Defaults to "en". See the [internationaliz
195206
```js
196207
// select a supported language
197208
var options = {
198-
language: 'en'
209+
language: 'es'
199210
};
200211
```
201212

202-
![](/media/articles/libraries/lock/customization/language.png)
213+
<img width="300" src="/media/articles/libraries/lock/customization/lock-language.png" />
214+
203215

204216
### languageDictionary {Object}
205217

@@ -214,7 +226,8 @@ var options = {
214226
};
215227
```
216228

217-
![](/media/articles/libraries/lock/customization/languageDictionary.png)
229+
<img width="300" src="/media/articles/libraries/lock/customization/lock-languagedictionary.png" />
230+
218231

219232
### popupOptions {Object}
220233

@@ -229,8 +242,6 @@ var options = {
229242
};
230243
```
231244

232-
![](/media/articles/libraries/lock/customization/popupOptions.png)
233-
234245
### rememberLastLogin {Boolean}
235246

236247
Determines whether or not to show a screen that allows you to quickly log in with the account you used the last time. Defaults to true.
@@ -242,8 +253,6 @@ var options = {
242253
};
243254
```
244255

245-
![](/media/articles/libraries/lock/customization/rememberLastLogin.png)
246-
247256
---
248257

249258
## Theming Options
@@ -264,10 +273,9 @@ var options = {
264273
};
265274
```
266275

267-
::: panel-info Customizing Text
268-
The label can be customized through the [languageDictionary](#languagedictionary-object-) option.
269-
:::
276+
<img width="300" src="/media/articles/libraries/lock/customization/lock-labeledsubmitbutton.png" />
270277

278+
If the label is set to true, which is the default, the label's text can be customized through the [languageDictionary](#languagedictionary-object-) option.
271279

272280
#### logo {String}
273281

@@ -276,24 +284,30 @@ The value for `logo` is an URL for an image that will be placed in the Lock's he
276284
```js
277285
var options = {
278286
theme: {
279-
logo: 'https://example.com/assets/logo.png'
287+
logo: 'https://example.com/logo.png'
280288
}
281289
};
282290
```
283291

292+
<img width="300" src="/media/articles/libraries/lock/customization/lock-logo.png" />
293+
294+
284295
#### primaryColor {String}
285296

286297
The `primaryColor` property defines the primary color of the Lock; all colors used in the widget will be calculated from it. This option is useful when providing a custom `logo`, to ensure all colors go well together with the `logo`'s color palette. Defaults to `#ea5323`.
287298

288299
```js
289300
var options = {
290301
theme: {
291-
logo: 'https://example.com/assets/logo.png',
292-
primaryColor: 'green'
302+
logo: 'https://example.com/logo.png',
303+
primaryColor: '#31324F'
293304
}
294305
};
295306
```
296307

308+
<img width="300" src="/media/articles/libraries/lock/customization/lock-primarycolor.png" />
309+
310+
297311
---
298312

299313
## Social Options
@@ -304,38 +318,51 @@ Determines the size of the buttons for the social providers. Possible values are
304318
- If only social connections are available, it will default to `big` when there are 5 connections at most, and default to `small` otherwise.
305319
- If connections from types other than social are also available, it will default to `big` when there are 3 social connections at most, and default to `small` otherwise.
306320

321+
First example, with three social connections, and other connections - forcing small buttons.
322+
307323
```js
308-
// First image, with three connections, and other connections - forcing small buttons
309324
var options = {
310-
allowedConnections: ['facebook', 'linkedin', 'amazon'],
311325
socialButtonStyle: 'small'
312326
};
313327
```
314328

329+
<img width="300" src="/media/articles/libraries/lock/customization/lock-socialbuttonstyle-small_default.png" />
330+
331+
---
332+
333+
Second example, with `socialButtonStyle` remaining at default behavior - three social connections, no other connections
334+
315335
```js
316-
// Second image, with socialButtonStyle remaining at default behavior - three connections, no other connections
317336
var options = {
318-
allowedConnections: ['facebook', 'linkedin', 'amazon']
337+
allowedConnections: ['facebook', 'linkedin', 'twitter']
319338
};
320339
```
321340

341+
<img width="300" src="/media/articles/libraries/lock/customization/lock-socialbuttonstyle-default_limited.png" />
342+
343+
---
344+
345+
Third example, with `socialButtonStyle` remaining at default behavior - the app has three social connections, with other connections allowed.
346+
322347
```js
323-
// Third image, with socialButtonStyle remaining at default behavior - three connections, with other connections
324-
var options = {
325-
allowedConnections: ['facebook', 'linkedin', 'amazon']
326-
};
348+
var options = {};
327349
```
328350

351+
<img width="300" src="/media/articles/libraries/lock/customization/lock-default.png" />
352+
353+
---
354+
355+
Fourth example, with three social connections, and no other connections - forcing small buttons.
356+
329357
```js
330-
// Fourth image, with three connections, and no other connections - forcing small buttons
331358
var options = {
332-
allowedConnections: ['facebook', 'linkedin', 'amazon'],
359+
allowedConnections: ['facebook', 'linkedin', 'twitter'],
333360
socialButtonStyle: 'small'
334361
};
335362
```
336363

337-
![](/media/articles/libraries/lock/customization/socialBigButtons.png)
338-
364+
<img width="300" src="/media/articles/libraries/lock/customization/lock-socialbuttonstyle-small_limited.png" />
365+
339366
---
340367

341368
## Authentication Options
@@ -486,6 +513,9 @@ var options = {
486513
}
487514
```
488515

516+
<img width="300" src="/media/articles/libraries/lock/customization/lock-additionalsignupfields.png" />
517+
518+
489519
#### Select Field
490520

491521
```js
@@ -540,6 +570,15 @@ Some use cases may be able to use `additionalSignupFields` data for email templa
540570

541571
When set to `false` the widget won't display the login screen. This is useful if you want to use the widget just for signups (the login and signup tabs in the signup screen will be hidden) or to reset passwords (the back button in the forgot password screen will be hidden). In such cases you may also need to specify the `initialScreen`, `allowForgotPassword` and `allowSignUp` options. It defaults to `true`.
542572

573+
```js
574+
//
575+
var options = {
576+
allowLogin: false
577+
};
578+
```
579+
580+
<img width="300" src="/media/articles/libraries/lock/customization/lock-allowlogin.png" />
581+
543582
### allowForgotPassword {Boolean}
544583

545584
When set to false, `allowForgotPassword` hides the "Don't remember your password?" link in the Login screen, making the Forgot Password screen unreachable. Defaults to true.
@@ -548,15 +587,14 @@ When set to false, `allowForgotPassword` hides the "Don't remember your password
548587
Keep in mind that if you are using a database connection with a custom database which doesn't have a change password script the Forgot Password screen won't be available.
549588
:::
550589

551-
552590
```js
553591
//
554592
var options = {
555-
allowForgotPassword: true
593+
allowForgotPassword: false
556594
};
557595
```
558596

559-
![](/media/articles/libraries/lock/customization/allowForgotPassword.png)
597+
<img width="300" src="/media/articles/libraries/lock/customization/lock-allowforgotpassword.png" />
560598

561599
### allowSignUp {Boolean}
562600

@@ -570,7 +608,7 @@ var options = {
570608
};
571609
```
572610

573-
![](/media/articles/libraries/lock/customization/disableSignupAction.png)
611+
<img width="300" src="/media/articles/libraries/lock/customization/lock-allowsignup.png" />
574612

575613
### defaultDatabaseConnection {String}
576614

@@ -661,8 +699,6 @@ var options = {
661699
};
662700
```
663701

664-
![](/media/articles/libraries/lock/customization/usernameStyle.png)
665-
666702
---
667703

668704
## Enterprise Options
@@ -687,8 +723,6 @@ var options = {
687723
};
688724
```
689725

690-
![](/media/articles/libraries/lock/customization/defaultADUsernameFromEmailPrefix.png)
691-
692726
### integratedWindowsLogin {Boolean}
693727

694728
Allows for Realm discovery by `AD`, `LDAP` connections. Defaults to `true`.
30.2 KB
Loading
39.1 KB
Loading
43.8 KB
Loading
43.6 KB
Loading
43 KB
Loading
45.1 KB
Loading
45.5 KB
Loading
46 KB
Loading
35.4 KB
Loading

0 commit comments

Comments
 (0)