@stripe/ui-extension-sdk
Advanced tools
The suite of functionality available to UI extensions in Stripe apps
For details on creating a Stripe App using this SDK, please refer to the Stripe App documentation.
pending prop to Button component.new variant value to type prop in Badge component.BarChart and LineChart components.
decimal.nice option to have more pleasing axis limits.ticks to specify the number of markets along an axis.tickFormat to modify the display of the tick labels.zero to control the visibility of the zero value.fractionalDigits option to currency formats to control the precision of numeric values.onChange prop in the DateField component now directly receives the value instead of the change event.layout prop values in the FormFieldGroup component have changed from row and column to horizontal and vertical.tabKey prop from Tab and TabPanel components. Use the id prop instead.className prop from Button and Link components.invalid prop from FormFieldGroup component.onKeyPress prop from TextArea and TextField components.background property on Box and Inline components' css prop. Use the backgroundColor property instead.layout property on Box and Inline components' css prop. Use the stack property instead.borderColor, borderTopColor, borderRightColor, borderBottomColor, borderLeftColor) on Box and Inline components' css prop. Use the keyline property for border styling instead.value prop to DateField component.background property on Box and Inline components' css prop. Use the backgroundColor property instead.className prop on Button and Link components.invalid prop on FormFieldGroup component.layout property on Box and Inline components' css prop. Use the stack property instead.tabKey prop on Tab and TabPanel components.borderColor, borderTopColor, borderRightColor, borderBottomColor, borderLeftColor) on Box and Inline components' css prop. Use the keyline property for border styling instead.value and checked props.StripeFileUploader componentplatform prop to environment contextappContext to the ExtensionContextValue typeAuthorizedPermission and AuthorizedContentSecurityPolicyappContext
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.roles to the account passed to extensions in the userContext propertysecondaryAction prop to SignInViewtarget to SignInView action propshref and onPress on SignInView action propsconstants prop to environment contextSignInView componentcontentUses property from TableCell and TableHeaderCell typinguseToast to return show and dismiss utility methodsStripeAppsHttpResponse.prototype.toJSON() now returns a rejected promise if the HTTP response body was emptyfetchStripeSignature with nested JSONdebug to filter props according to all optiontabKey to Tab and TabPanelstripe package dependency to ^9.11.0external to LinksetShown prop to FocusViewshowToast utility function for rendering toast notifications at the bottom of an app's viewExtensionContextValue typing to mark name and objectContext values as possibly nulltextAlign to Box cssonSave prop optional for SettingsView components@remote-ui/react 4.5.2Sparkline componentvalue prop on TextArea, TextField, and Select componentschecked prop on Checkbox, Radio, and Switch componentsouterRef props from inputsbrandIcon and brandColor to ContextViewNotice component - use BanneroverflowX and overflowY to Box cssBanner componentNotice componentlocale to ExtensionContextValue['oauthContext']overflowWrap and wordBreak to Box css propertiestextTransform to Box and Inline css propertiesprimaryAction, secondaryAction, and footerContent properties to ContextView.whiteSpace to Box css propertiesBarChart and LineChart improvements:
FocusViewChip and ChipList componentsgetDashboardUserEmail utility to return the email directly and reject the promise if there's an errorlabel prop of form elementstext-overflow: ellipsis and word-wrap: normal | break-word on Box csscountry to the account passed to extensions in the userContext propertydata: URL support for the Img component - docsSwitch, Checkbox and RadioAccordion, Icon, Spinner, and Tooltip componentsBarChart and LineChartBarChart and LineChartcss={{ width: ... }} on Select, TextArea, TextField, Button, and Linkcss={{ alignX: ... }} on Button and LinkclipboardWriteText functiongetDashboardUserEmail functionslot propertycreateOAuthState functionoauthContext to the ExtensionContextValue typeImg componentNotice, Charts, and Tabs componentsListItem: Previously, content passed as children would be the primary content rendered in the component. Now, main content is passed to the title prop. The description slot has also been reassigned to a secondaryTitle prop.MenuTrigger: This component has been deprecated in favor of a trigger prop on the Menu component. Slot API usage has also been removed.docs.json files in distactions prop to ContextView.ButtonGroup component.margin-bottom from form controls.white-space: nowrap and alignY: center by default.min-height on all size variants.Link and Button shrink to fit their content.defaultValue attribute on TextField and TextArea.error and description to be hidden on form controls via the hiddenElements prop.invalid and size props on Select and TextArea.defaultChecked attribute on Radio.resizeable and rows props on TextArea.Chip onDropdown firing twice.Divider rendering.useRefreshDashboardData that resolves after dashboard data is refreshed.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..is would sometimes fail to identify a component.testing package in which comopnents with fragment props were not findable using wrapper.find()SettingsViewSettingsView types to match the available component propsgetMockContextProps helper for testing. See the docs for details.React.ReactNode as a valid type to the value prop, rather than just a string.MenuGroup now supports the title propFocusView now supports the footerContent propSettingsView now supports the headerActions propFocusView, SettingsView, and ContextViewSTRIPE_API_KEY from http_client to be used when initializing the Stripe API client.FAQs
The suite of functionality available to UI extensions in Stripe apps
The npm package @stripe/ui-extension-sdk receives a total of 1,865 weekly downloads. As such, @stripe/ui-extension-sdk popularity was classified as popular.
We found that @stripe/ui-extension-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 50 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.