Skip to content

Commit

Permalink
[skip ci] Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Apr 20, 2021
1 parent e00388d commit 2baa0aa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The SPIDButtonProps object contains the following properties:

#### configuration

**Possible values**: `{ method : "GET" } | { extraFields ?: Record<string | string>, fieldName : string, method : "POST" }`
**Possible values**: `{ method : "GET" } | { extraFields ?: Record<string , string>, fieldName : string, method : "POST" }`

**Type**: `ConfigurationGET | ConfigurationPOST`

Expand Down Expand Up @@ -164,7 +164,7 @@ The language used for the UI. The default value is `"it"`.
#### mapping


**Type**: `Record<string | string>`
**Type**: `Record<string , string>`

**Required**: No

Expand All @@ -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<HTMLAnchorElement | MouseEvent> | React.MouseEvent<HTMLButtonElement | MouseEvent>) => void`
event : React.MouseEvent<HTMLAnchorElement , MouseEvent> | React.MouseEvent<HTMLButtonElement , MouseEvent>) => void`

**Required**: No

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -394,7 +394,7 @@ This is the specific GET type.

___

**ConfigurationPOST**: `{extraFields: Record<string | string>, fieldName: string, method: "POST"}`
**ConfigurationPOST**: `{extraFields: Record<string , string>, fieldName: string, method: "POST"}`

Each Provider button will use this configuration for its button.
This is the specific POST type
Expand Down
10 changes: 5 additions & 5 deletions example/public/doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The SPIDButtonProps object contains the following properties:

#### configuration

**Possible values**: `{ method : "GET" } | { extraFields ?: Record<string | string>, fieldName : string, method : "POST" }`
**Possible values**: `{ method : "GET" } | { extraFields ?: Record<string , string>, fieldName : string, method : "POST" }`

**Type**: `ConfigurationGET | ConfigurationPOST`

Expand Down Expand Up @@ -92,7 +92,7 @@ The language used for the UI. The default value is `"it"`.
#### mapping


**Type**: `Record<string | string>`
**Type**: `Record<string , string>`

**Required**: No

Expand All @@ -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<HTMLAnchorElement | MouseEvent> | React.MouseEvent<HTMLButtonElement | MouseEvent>) => void`
event : React.MouseEvent<HTMLAnchorElement , MouseEvent> | React.MouseEvent<HTMLButtonElement , MouseEvent>) => void`

**Required**: No

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -322,7 +322,7 @@ This is the specific GET type.

___

**ConfigurationPOST**: `{extraFields: Record<string | string>, fieldName: string, method: "POST"}`
**ConfigurationPOST**: `{extraFields: Record<string , string>, fieldName: string, method: "POST"}`

Each Provider button will use this configuration for its button.
This is the specific POST type
Expand Down

1 comment on commit 2baa0aa

@vercel
Copy link

@vercel vercel bot commented on 2baa0aa Apr 20, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.