diff --git a/README.md b/README.md index cd488785..187d1266 100644 --- a/README.md +++ b/README.md @@ -103,7 +103,7 @@ import { | | Required props | Optional props | | ---------------------------- | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **All** | **`children`** (string/element): React node
**`url`** (string): URL of the shared page | **`disabled`** (bool): Disables click action and adds "disabled" class
**`disabledStyle`** (object, default=`{ opacity: 0.6 }`): Disabled style
**`windowWidth`, `windowHeight`** (number, different default for all share buttons): opened window dimensions
**`beforeOnClick`** (`() => Promise`/`() => void`): Takes a function that returns a Promise to be fulfilled before calling `onClick`. If you do not return promise, `onClick` is called immediately.
**`openShareDialogOnClick`** (boolean): Open dialog on click. Defaults to `true` except on EmailShareButton
**`onShareWindowClose`** (`() => void`): Takes a function to be called after closing share dialog.
**`resetButtonStyle`** (boolean, default=`true`): Reset `button` element style. Preferred to be set to `false` if you want to customize the button style. | +| **All** | **`children`** (string/element): React node
**`url`** (string): URL of the shared page | **`htmlTitle`** (string): Adds accessible `title=""` attribute to button the element
**`disabled`** (bool): Disables click action and adds "disabled" class
**`disabledStyle`** (object, default=`{ opacity: 0.6 }`): Disabled style
**`windowWidth`, `windowHeight`** (number, different default for all share buttons): opened window dimensions
**`beforeOnClick`** (`() => Promise`/`() => void`): Takes a function that returns a Promise to be fulfilled before calling `onClick`. If you do not return promise, `onClick` is called immediately.
**`openShareDialogOnClick`** (boolean): Open dialog on click. Defaults to `true` except on EmailShareButton
**`onShareWindowClose`** (`() => void`): Takes a function to be called after closing share dialog.
**`resetButtonStyle`** (boolean, default=`true`): Reset `button` element style. Preferred to be set to `false` if you want to customize the button style. | | EmailShareButton | - | **`subject`** (string): Title of the shared page
**`body`** (string): Email, will be prepended to the url.
**`separator`** (string, default=`" "`): Separates body from the url | | FacebookShareButton | - | **`hashtag`** (string): A hashtag specified by the developer to be added to the shared content. People will still have the opportunity to remove this hashtag in the dialog. The hashtag should include the hash symbol. | | FacebookMessengerShareButton | **`appId`** (string): Facebook application id | **`redirectUri`** (string): The URL to redirect to after sharing (default: the shared url).
**`to`** (string): A user ID of a recipient. Once the dialog comes up, the sender can specify additional people as recipients. |