diff --git a/README.md b/README.md index c92ad57..81d3bd1 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ The SPIDButtonProps object contains the following properties: #### configuration -**Possible values**: `{ method : "GET" } | { extraFields ?: Record, fieldName : string, method : "POST" }` +**Possible values**: `{ method : "GET" } | { extraFields ?: Record, fieldName : string, method : "POST" }` **Type**: `ConfigurationGET | ConfigurationPOST` @@ -164,7 +164,7 @@ The language used for the UI. The default value is `"it"`. #### mapping -**Type**: `Record` +**Type**: `Record` **Required**: No @@ -181,7 +181,7 @@ This is useful when a Service Provider identifies the IDP with a different strin **Type**: `( providerEntry : ProviderRecord, loginURL : string | undefined, -event : React.MouseEvent | React.MouseEvent) => void` +event : React.MouseEvent | React.MouseEvent) => void` **Required**: No @@ -262,7 +262,7 @@ The default value is `"md"`. **Required**: No -**Default value**: false +**Default value**: `false` It forces an ascending order (A->Z) of the providers, based on the entityName string. @@ -394,7 +394,7 @@ This is the specific GET type. ___ -**ConfigurationPOST**: `{extraFields: Record, fieldName: string, method: "POST"}` +**ConfigurationPOST**: `{extraFields: Record, fieldName: string, method: "POST"}` Each Provider button will use this configuration for its button. This is the specific POST type diff --git a/example/public/doc.md b/example/public/doc.md index 2badaff..5a330f7 100644 --- a/example/public/doc.md +++ b/example/public/doc.md @@ -15,7 +15,7 @@ The SPIDButtonProps object contains the following properties: #### configuration -**Possible values**: `{ method : "GET" } | { extraFields ?: Record, fieldName : string, method : "POST" }` +**Possible values**: `{ method : "GET" } | { extraFields ?: Record, fieldName : string, method : "POST" }` **Type**: `ConfigurationGET | ConfigurationPOST` @@ -92,7 +92,7 @@ The language used for the UI. The default value is `"it"`. #### mapping -**Type**: `Record` +**Type**: `Record` **Required**: No @@ -109,7 +109,7 @@ This is useful when a Service Provider identifies the IDP with a different strin **Type**: `( providerEntry : ProviderRecord, loginURL : string | undefined, -event : React.MouseEvent | React.MouseEvent) => void` +event : React.MouseEvent | React.MouseEvent) => void` **Required**: No @@ -190,7 +190,7 @@ The default value is `"md"`. **Required**: No -**Default value**: false +**Default value**: `false` It forces an ascending order (A->Z) of the providers, based on the entityName string. @@ -322,7 +322,7 @@ This is the specific GET type. ___ -**ConfigurationPOST**: `{extraFields: Record, fieldName: string, method: "POST"}` +**ConfigurationPOST**: `{extraFields: Record, fieldName: string, method: "POST"}` Each Provider button will use this configuration for its button. This is the specific POST type