Stripe UI Extension SDK
For details on creating a Stripe App using this SDK, please refer to the Stripe App documentation.
Changelog
8.8.0
- Add
StripeFileUploader
component - Add
platform
prop to environment context - Add
appContext
to theExtensionContextValue
type - Add some utility functions for interacting with
appContext
-
getUserAuthorizedPermissions
: Gets the intersection of the app's authorized permissions and those of the current Dashboard user. -
isPermissionAuthorized
: Indicates if a permission is in the app's authorized permissions. -
isSourceInAuthorizedCSP
: Indicates if a URL is in the app's authorized connect or image sources.
-
8.7.0
- Add
roles
to the account passed to extensions in theuserContext
property
8.6.0
- Add
secondaryAction
prop toSignInView
- Add
target
toSignInView
action props - Allow both
href
andonPress
onSignInView
action props
8.5.0
- Add
constants
prop to environment context
8.4.1
- Add
SignInView
component
8.3.0
- Remove unsupported
contentUses
property fromTableCell
andTableHeaderCell
typing - Updated
useToast
to returnshow
anddismiss
utility methods
8.2.0
-
StripeAppsHttpResponse.prototype.toJSON()
now returns a rejected promise if the HTTP response body was empty - Add support for calling
fetchStripeSignature
with nested JSON - Fix
debug
to filter props according toall
option - Add
tabKey
toTab
andTabPanel
- Upgrade
stripe
package dependency to^9.11.0
- Add
external
toLink
- Add
setShown
prop toFocusView
- Add
showToast
utility function for rendering toast notifications at the bottom of an app's view
8.1.0
- Fix
ExtensionContextValue
typing to markname
andobjectContext
values as possiblynull
- Add
textAlign
toBox
css
- Make
onSave
prop optional forSettingsView
components - Upgrade to
@remote-ui/react
4.5.2 - Add
Sparkline
component
8.0.0
- Add deprecation notice to the
value
prop onTextArea
,TextField
, andSelect
components - Add deprecation notice to the
checked
prop onCheckbox
,Radio
, andSwitch
components - Remove unsupported
outerRef
props from inputs
7.1.0
- Add
brandIcon
andbrandColor
toContextView
7.0.0
- Deprecate
Notice
component - useBanner
- Add
overflowX
andoverflowY
toBox
css
6.3.1
- Internal update, no user-facing changes
6.3.0
- Add
Banner
component - Add deprecation warning for
Notice
component - Add
locale
toExtensionContextValue['oauthContext']
- Add
overflowWrap
andwordBreak
toBox
css
properties - Add
textTransform
toBox
andInline
css
properties - Add
primaryAction
,secondaryAction
, andfooterContent
properties toContextView
. - Add
whiteSpace
toBox
css
properties
6.2.0
-
BarChart
andLineChart
improvements:- Configurable axis formatting
- Configurable value formatting
- Configurable channel domains
- Configurable channel ranges
- Show/hide axis labels and ticks in charts
- Show/hide grid lines in charts
- Show/hide tooltips in chart presets
- Show/hide legends in chart presets
6.1.0
- Add a confirmation dialog to
FocusView
- Add
Chip
andChipList
components - Update the
getDashboardUserEmail
utility to return the email directly and reject the promise if there's an error - Fix React components not being accepted in the
label
prop of form elements - Expose
text-overflow: ellipsis
andword-wrap: normal | break-word
onBox
css
- Add
country
to the account passed to extensions in theuserContext
property - Add
data:
URL support for theImg
component - docs
6.0.0
- Deprecate email in view context
- Consolidated utilites in /utils path
- Fixed react-reconciler dependency issue affecting unit tests
5.0.1
- Fix prop types for
Switch
,Checkbox
andRadio
5.0.0
- Adds the
Accordion
,Icon
,Spinner
, andTooltip
components - Adds tooltips to
BarChart
andLineChart
- Fix prop typing for
BarChart
andLineChart
- Deprecates legacy view context parameters
- Enables setting width via
css={{ width: ... }}
onSelect
,TextArea
,TextField
,Button
, andLink
- Enables setting internal horizontal alignment via
css={{ alignX: ... }}
onButton
andLink
- Adds the
clipboardWriteText
function - Adds the
getDashboardUserEmail
function
4.0.0
- Deprecates the
slot
property
3.2.0
- Adds the
createOAuthState
function - Adds
oauthContext
to theExtensionContextValue
type
3.1.0
- Adds the
Img
component
3.0.0
- Adds support for the
Notice
,Charts
, andTabs
components - Breaking changes:
-
ListItem
: Previously, content passed as children would be the primary content rendered in the component. Now, main content is passed to thetitle
prop. Thedescription
slot has also been reassigned to asecondaryTitle
prop. -
MenuTrigger
: This component has been deprecated in favor of atrigger
prop on theMenu
component. Slot API usage has also been removed.
-
- Removed permissions from being passed into the user context.
2.2.1
- Expose
docs.json
files indist
2.2.0
- Add
actions
prop toContextView
.
2.1.0
- Introduces
ButtonGroup
component. - Removes
margin-bottom
from form controls. - Gives Button
white-space: nowrap
andalignY: center
by default. - Button themes now set a
min-height
on all size variants. - Makes
Link
andButton
shrink to fit their content. - Exposes
defaultValue
attribute onTextField
andTextArea
. - Allows
error
anddescription
to be hidden on form controls via thehiddenElements
prop. - Exposes
invalid
andsize
props onSelect
andTextArea
. - Exposes
defaultChecked
attribute onRadio
. - Exposes
resizeable
androws
props onTextArea
. - Fixes invalid state on control components.
- Fixes
Chip
onDropdown
firing twice. - Fixes
Divider
rendering.
2.0.3
- Returns a promise from
useRefreshDashboardData
that resolves after dashboard data is refreshed. - Adds
fetchStripeSignature
method that optionally accepts additional request payload. Signature can be used to make authenticated request to your app's backend. See the docs for details. - Fixes an issue where the test element check method
.is
would sometimes fail to identify a component.
2.0.2
- Fixes an issue with the
testing
package in which comopnents with fragment props were not findable usingwrapper.find()
2.0.1
- Pulls in updated dependency that fixes #55 and #161
2.0.0
- Fixes a render error with
SettingsView
- Updates
SettingsView
types to match the available component props - Adds a
getMockContextProps
helper for testing. See the docs for details. - List component now accepts
React.ReactNode
as a valid type to thevalue
prop, rather than just astring
. - Adds hover state to ListItem components
- Updates ListItem component such that hover state is only visible when there is an action associated
- Fix Select rendering when multiple is true
- Fix Checkbox onChange firing twice
1.1.7
- Adds a "testing" module, which includes helpers for writing Jest tests for apps. See the docs for details.
- Fixes some components that take React nodes as props
-
MenuGroup
now supports thetitle
prop -
FocusView
now supports thefooterContent
prop -
SettingsView
now supports theheaderActions
prop
-
- Some type fixes and grammar updates.
1.1.6
- Added types for
FocusView
,SettingsView
, andContextView
- Exporting a new constant
STRIPE_API_KEY
from http_client to be used when initializing the Stripe API client.