Choose a version:

AppProvider

Sets up the Polaris AppProvider and injects the App Bridge script.

This component extends the AppProvider component from Polaris, and accepts all of its props except for linkComponent, which is overridden to use the Remix Link component.

Anchor to appproviderpropsAppProviderProps

Anchor to i18n i18n | [] required: A locale object or array of locale objects that overrides default translations. If specifying an array then your primary language dictionary should come first, followed by your fallback language dictionaries
Anchor to children children React.ReactNode: Inner content of the application
Anchor to features features: For toggling features
Anchor to linkComponent linkComponent: A custom component to use for all links used by Polaris components
Anchor to theme theme ThemeName

FeaturesConfig

[key: string]
```
boolean | undefined
```
dynamicTopBarAndReframe
```
boolean
```

TranslationDictionary

[key: string]
```
string | TranslationDictionary
```

LinkLikeComponent

React.ComponentType<LinkLikeComponentProps>

LinkLikeComponentProps

[key: string]
```
any
```
about
```
string | undefined
```
accept
```
string | undefined
```
acceptCharset
```
string | undefined
```
accessKey
```
string | undefined
```

action

| string
            | undefined
            | ((formData: FormData) => void | Promise<void>)
            | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS[
                keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS
            ]

allowFullScreen
```
boolean | undefined
```
allowTransparency
```
boolean | undefined
```
alt
```
string | undefined
```
aria-activedescendant
Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
```
string | undefined
```
aria-atomic
Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
```
Booleanish | undefined
```
aria-autocomplete
Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
```
"none" | "inline" | "list" | "both" | undefined
```
aria-braillelabel
Defines a string value that labels the current element, which is intended to be converted into Braille.
```
string | undefined
```
aria-brailleroledescription
Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
```
string | undefined
```
aria-busy
```
Booleanish | undefined
```
aria-checked
Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
```
boolean | "false" | "mixed" | "true" | undefined
```
aria-colcount
Defines the total number of columns in a table, grid, or treegrid.
```
number | undefined
```
aria-colindex
Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
```
number | undefined
```
aria-colindextext
Defines a human readable text alternative of aria-colindex.
```
string | undefined
```
aria-colspan
Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
```
number | undefined
```
aria-controls
Identifies the element (or elements) whose contents or presence are controlled by the current element.
```
string | undefined
```
aria-current
Indicates the element that represents the current item within a container or set of related elements.
```
boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined
```
aria-describedby
Identifies the element (or elements) that describes the object.
```
string | undefined
```
aria-description
Defines a string value that describes or annotates the current element.
```
string | undefined
```
aria-details
Identifies the element that provides a detailed, extended description for the object.
```
string | undefined
```
aria-disabled
Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
```
Booleanish | undefined
```
aria-dropeffect
Indicates what functions can be performed when a dragged object is released on the drop target.
```
"none" | "copy" | "execute" | "link" | "move" | "popup" | undefined
```
aria-errormessage
Identifies the element that provides an error message for the object.
```
string | undefined
```
aria-expanded
Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
```
Booleanish | undefined
```
aria-flowto
Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
```
string | undefined
```
aria-grabbed
Indicates an element's "grabbed" state in a drag-and-drop operation.
```
Booleanish | undefined
```
aria-haspopup
Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
```
boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined
```
aria-hidden
Indicates whether the element is exposed to an accessibility API.
```
Booleanish | undefined
```
aria-invalid
Indicates the entered value does not conform to the format expected by the application.
```
boolean | "false" | "true" | "grammar" | "spelling" | undefined
```
aria-keyshortcuts
Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
```
string | undefined
```
aria-label
Defines a string value that labels the current element.
```
string | undefined
```
aria-labelledby
Identifies the element (or elements) that labels the current element.
```
string | undefined
```
aria-level
Defines the hierarchical level of an element within a structure.
```
number | undefined
```
aria-live
Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
```
"off" | "assertive" | "polite" | undefined
```
aria-modal
Indicates whether an element is modal when displayed.
```
Booleanish | undefined
```
aria-multiline
Indicates whether a text box accepts multiple lines of input or only a single line.
```
Booleanish | undefined
```
aria-multiselectable
Indicates that the user may select more than one item from the current selectable descendants.
```
Booleanish | undefined
```
aria-orientation
Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
```
"horizontal" | "vertical" | undefined
```
aria-owns
Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
```
string | undefined
```
aria-placeholder
Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
```
string | undefined
```
aria-posinset
Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
```
number | undefined
```
aria-pressed
Indicates the current "pressed" state of toggle buttons.
```
boolean | "false" | "mixed" | "true" | undefined
```
aria-readonly
Indicates that the element is not editable, but is otherwise operable.
```
Booleanish | undefined
```

aria-relevant

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

| "additions"
            | "additions removals"
            | "additions text"
            | "all"
            | "removals"
            | "removals additions"
            | "removals text"
            | "text"
            | "text additions"
            | "text removals"
            | undefined

aria-required
Indicates that user input is required on the element before a form may be submitted.
```
Booleanish | undefined
```
aria-roledescription
Defines a human-readable, author-localized description for the role of an element.
```
string | undefined
```
aria-rowcount
Defines the total number of rows in a table, grid, or treegrid.
```
number | undefined
```
aria-rowindex
Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
```
number | undefined
```
aria-rowindextext
Defines a human readable text alternative of aria-rowindex.
```
string | undefined
```
aria-rowspan
Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
```
number | undefined
```
aria-selected
Indicates the current "selected" state of various widgets.
```
Booleanish | undefined
```
aria-setsize
Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
```
number | undefined
```
aria-sort
Indicates if items in a table or grid are sorted in ascending or descending order.
```
"none" | "ascending" | "descending" | "other" | undefined
```
aria-valuemax
Defines the maximum allowed value for a range widget.
```
number | undefined
```
aria-valuemin
Defines the minimum allowed value for a range widget.
```
number | undefined
```
aria-valuenow
Defines the current value for a range widget.
```
number | undefined
```
aria-valuetext
Defines the human readable text alternative of aria-valuenow for a range widget.
```
string | undefined
```
as
```
string | undefined
```
async
```
boolean | undefined
```

autoCapitalize

"off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {})

autoComplete
```
string | undefined
```
autoCorrect
```
string | undefined
```
autoFocus
```
boolean | undefined
```
autoPlay
```
boolean | undefined
```
autoSave
```
string | undefined
```

capture

boolean | "user" | "environment" | undefined

cellPadding
```
number | string | undefined
```
cellSpacing
```
number | string | undefined
```
challenge
```
string | undefined
```
charSet
```
string | undefined
```
checked
```
boolean | undefined
```
children
The content to display inside the link
```
React.ReactNode
```
cite
```
string | undefined
```
classID
```
string | undefined
```
className
```
string | undefined
```
color
```
string | undefined
```
cols
```
number | undefined
```
colSpan
```
number | undefined
```
content
```
string | undefined
```

contentEditable

Booleanish | "inherit" | "plaintext-only" | undefined

contextMenu
```
string | undefined
```
controls
```
boolean | undefined
```
coords
```
string | undefined
```
crossOrigin
```
CrossOrigin
```

dangerouslySetInnerHTML

{
            // Should be InnerHTML['innerHTML'].
            // But unfortunately we're mixing renderer-specific type declarations.
            __html: string | TrustedHTML;
        } | undefined

data
```
string | undefined
```
datatype
```
string | undefined
```
dateTime
```
string | undefined
```
default
```
boolean | undefined
```
defaultChecked
```
boolean | undefined
```

defaultValue

string | number | readonly string[] | undefined

defer
```
boolean | undefined
```
dir
```
string | undefined
```
disabled
```
boolean | undefined
```
download
Makes the browser download the url instead of opening it. Provides a hint for the downloaded filename if it is a string value.
```
string | boolean
```
draggable
```
Booleanish | undefined
```
encType
```
string | undefined
```

enterKeyHint

"enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined

exportparts
```
string | undefined
```
external
Makes the link open in a new tab
```
boolean
```
form
```
string | undefined
```

formAction

| string
            | undefined
            | ((formData: FormData) => void | Promise<void>)
            | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS[
                keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS
            ]

formEncType
```
string | undefined
```
formMethod
```
string | undefined
```
formNoValidate
```
boolean | undefined
```
formTarget
```
string | undefined
```
frameBorder
```
number | string | undefined
```
headers
```
string | undefined
```
height
```
number | string | undefined
```
hidden
```
boolean | undefined
```
high
```
number | undefined
```
href
```
string | undefined
```
hrefLang
```
string | undefined
```
htmlFor
```
string | undefined
```
httpEquiv
```
string | undefined
```
id
```
string | undefined
```
inert
```
boolean | undefined
```
inlist
```
any
```
inputMode
Hints at the type of data that might be entered by the user while editing the element or its contents
```
"none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined
```
integrity
```
string | undefined
```
is
Specify that a standard HTML element should behave like a defined custom built-in element
```
string | undefined
```
itemID
```
string | undefined
```
itemProp
```
string | undefined
```
itemRef
```
string | undefined
```
itemScope
```
boolean | undefined
```
itemType
```
string | undefined
```
key
```
Key | null | undefined
```
keyParams
```
string | undefined
```
keyType
```
string | undefined
```
kind
```
string | undefined
```
label
```
string | undefined
```
lang
```
string | undefined
```
list
```
string | undefined
```
loop
```
boolean | undefined
```
low
```
number | undefined
```
manifest
```
string | undefined
```
marginHeight
```
number | undefined
```
marginWidth
```
number | undefined
```
max
```
number | string | undefined
```
maxLength
```
number | undefined
```
media
```
string | undefined
```
mediaGroup
```
string | undefined
```
method
```
string | undefined
```
min
```
number | string | undefined
```
minLength
```
number | undefined
```
multiple
```
boolean | undefined
```
muted
```
boolean | undefined
```
name
```
string | undefined
```
nonce
```
string | undefined
```
noValidate
```
boolean | undefined
```
onAbort
```
ReactEventHandler<T> | undefined
```
onAbortCapture
```
ReactEventHandler<T> | undefined
```
onAnimationEnd
```
AnimationEventHandler<T> | undefined
```
onAnimationEndCapture
```
AnimationEventHandler<T> | undefined
```
onAnimationIteration
```
AnimationEventHandler<T> | undefined
```
onAnimationIterationCapture
```
AnimationEventHandler<T> | undefined
```
onAnimationStart
```
AnimationEventHandler<T> | undefined
```
onAnimationStartCapture
```
AnimationEventHandler<T> | undefined
```
onAuxClick
```
MouseEventHandler<T> | undefined
```
onAuxClickCapture
```
MouseEventHandler<T> | undefined
```
onBeforeInput
```
InputEventHandler<T> | undefined
```
onBeforeInputCapture
```
InputEventHandler<T> | undefined
```
onBeforeToggle
```
ToggleEventHandler<T> | undefined
```
onBlur
```
FocusEventHandler<T> | undefined
```
onBlurCapture
```
FocusEventHandler<T> | undefined
```
onCanPlay
```
ReactEventHandler<T> | undefined
```
onCanPlayCapture
```
ReactEventHandler<T> | undefined
```
onCanPlayThrough
```
ReactEventHandler<T> | undefined
```
onCanPlayThroughCapture
```
ReactEventHandler<T> | undefined
```
onChange
```
ChangeEventHandler<T> | undefined
```
onChangeCapture
```
ChangeEventHandler<T> | undefined
```
onClick
```
MouseEventHandler<T> | undefined
```
onClickCapture
```
MouseEventHandler<T> | undefined
```
onCompositionEnd
```
CompositionEventHandler<T> | undefined
```
onCompositionEndCapture
```
CompositionEventHandler<T> | undefined
```
onCompositionStart
```
CompositionEventHandler<T> | undefined
```
onCompositionStartCapture
```
CompositionEventHandler<T> | undefined
```
onCompositionUpdate
```
CompositionEventHandler<T> | undefined
```
onCompositionUpdateCapture
```
CompositionEventHandler<T> | undefined
```
onContextMenu
```
MouseEventHandler<T> | undefined
```
onContextMenuCapture
```
MouseEventHandler<T> | undefined
```
onCopy
```
ClipboardEventHandler<T> | undefined
```
onCopyCapture
```
ClipboardEventHandler<T> | undefined
```
onCut
```
ClipboardEventHandler<T> | undefined
```
onCutCapture
```
ClipboardEventHandler<T> | undefined
```
onDoubleClick
```
MouseEventHandler<T> | undefined
```
onDoubleClickCapture
```
MouseEventHandler<T> | undefined
```
onDrag
```
DragEventHandler<T> | undefined
```
onDragCapture
```
DragEventHandler<T> | undefined
```
onDragEnd
```
DragEventHandler<T> | undefined
```
onDragEndCapture
```
DragEventHandler<T> | undefined
```
onDragEnter
```
DragEventHandler<T> | undefined
```
onDragEnterCapture
```
DragEventHandler<T> | undefined
```
onDragExit
```
DragEventHandler<T> | undefined
```
onDragExitCapture
```
DragEventHandler<T> | undefined
```
onDragLeave
```
DragEventHandler<T> | undefined
```
onDragLeaveCapture
```
DragEventHandler<T> | undefined
```
onDragOver
```
DragEventHandler<T> | undefined
```
onDragOverCapture
```
DragEventHandler<T> | undefined
```
onDragStart
```
DragEventHandler<T> | undefined
```
onDragStartCapture
```
DragEventHandler<T> | undefined
```
onDrop
```
DragEventHandler<T> | undefined
```
onDropCapture
```
DragEventHandler<T> | undefined
```
onDurationChange
```
ReactEventHandler<T> | undefined
```
onDurationChangeCapture
```
ReactEventHandler<T> | undefined
```
onEmptied
```
ReactEventHandler<T> | undefined
```
onEmptiedCapture
```
ReactEventHandler<T> | undefined
```
onEncrypted
```
ReactEventHandler<T> | undefined
```
onEncryptedCapture
```
ReactEventHandler<T> | undefined
```
onEnded
```
ReactEventHandler<T> | undefined
```
onEndedCapture
```
ReactEventHandler<T> | undefined
```
onError
```
ReactEventHandler<T> | undefined
```
onErrorCapture
```
ReactEventHandler<T> | undefined
```
onFocus
```
FocusEventHandler<T> | undefined
```
onFocusCapture
```
FocusEventHandler<T> | undefined
```
onGotPointerCapture
```
PointerEventHandler<T> | undefined
```
onGotPointerCaptureCapture
```
PointerEventHandler<T> | undefined
```
onInput
```
InputEventHandler<T> | undefined
```
onInputCapture
```
InputEventHandler<T> | undefined
```
onInvalid
```
ReactEventHandler<T> | undefined
```
onInvalidCapture
```
ReactEventHandler<T> | undefined
```
onKeyDown
```
KeyboardEventHandler<T> | undefined
```
onKeyDownCapture
```
KeyboardEventHandler<T> | undefined
```
onKeyPress
```
KeyboardEventHandler<T> | undefined
```
onKeyPressCapture
```
KeyboardEventHandler<T> | undefined
```
onKeyUp
```
KeyboardEventHandler<T> | undefined
```
onKeyUpCapture
```
KeyboardEventHandler<T> | undefined
```
onLoad
```
ReactEventHandler<T> | undefined
```
onLoadCapture
```
ReactEventHandler<T> | undefined
```
onLoadedData
```
ReactEventHandler<T> | undefined
```
onLoadedDataCapture
```
ReactEventHandler<T> | undefined
```
onLoadedMetadata
```
ReactEventHandler<T> | undefined
```
onLoadedMetadataCapture
```
ReactEventHandler<T> | undefined
```
onLoadStart
```
ReactEventHandler<T> | undefined
```
onLoadStartCapture
```
ReactEventHandler<T> | undefined
```
onLostPointerCapture
```
PointerEventHandler<T> | undefined
```
onLostPointerCaptureCapture
```
PointerEventHandler<T> | undefined
```
onMouseDown
```
MouseEventHandler<T> | undefined
```
onMouseDownCapture
```
MouseEventHandler<T> | undefined
```
onMouseEnter
```
MouseEventHandler<T> | undefined
```
onMouseLeave
```
MouseEventHandler<T> | undefined
```
onMouseMove
```
MouseEventHandler<T> | undefined
```
onMouseMoveCapture
```
MouseEventHandler<T> | undefined
```
onMouseOut
```
MouseEventHandler<T> | undefined
```
onMouseOutCapture
```
MouseEventHandler<T> | undefined
```
onMouseOver
```
MouseEventHandler<T> | undefined
```
onMouseOverCapture
```
MouseEventHandler<T> | undefined
```
onMouseUp
```
MouseEventHandler<T> | undefined
```
onMouseUpCapture
```
MouseEventHandler<T> | undefined
```
onPaste
```
ClipboardEventHandler<T> | undefined
```
onPasteCapture
```
ClipboardEventHandler<T> | undefined
```
onPause
```
ReactEventHandler<T> | undefined
```
onPauseCapture
```
ReactEventHandler<T> | undefined
```
onPlay
```
ReactEventHandler<T> | undefined
```
onPlayCapture
```
ReactEventHandler<T> | undefined
```
onPlaying
```
ReactEventHandler<T> | undefined
```
onPlayingCapture
```
ReactEventHandler<T> | undefined
```
onPointerCancel
```
PointerEventHandler<T> | undefined
```
onPointerCancelCapture
```
PointerEventHandler<T> | undefined
```
onPointerDown
```
PointerEventHandler<T> | undefined
```
onPointerDownCapture
```
PointerEventHandler<T> | undefined
```
onPointerEnter
```
PointerEventHandler<T> | undefined
```
onPointerLeave
```
PointerEventHandler<T> | undefined
```
onPointerMove
```
PointerEventHandler<T> | undefined
```
onPointerMoveCapture
```
PointerEventHandler<T> | undefined
```
onPointerOut
```
PointerEventHandler<T> | undefined
```
onPointerOutCapture
```
PointerEventHandler<T> | undefined
```
onPointerOver
```
PointerEventHandler<T> | undefined
```
onPointerOverCapture
```
PointerEventHandler<T> | undefined
```
onPointerUp
```
PointerEventHandler<T> | undefined
```
onPointerUpCapture
```
PointerEventHandler<T> | undefined
```
onProgress
```
ReactEventHandler<T> | undefined
```
onProgressCapture
```
ReactEventHandler<T> | undefined
```
onRateChange
```
ReactEventHandler<T> | undefined
```
onRateChangeCapture
```
ReactEventHandler<T> | undefined
```
onReset
```
ReactEventHandler<T> | undefined
```
onResetCapture
```
ReactEventHandler<T> | undefined
```
onScroll
```
UIEventHandler<T> | undefined
```
onScrollCapture
```
UIEventHandler<T> | undefined
```
onScrollEnd
```
UIEventHandler<T> | undefined
```
onScrollEndCapture
```
UIEventHandler<T> | undefined
```
onSeeked
```
ReactEventHandler<T> | undefined
```
onSeekedCapture
```
ReactEventHandler<T> | undefined
```
onSeeking
```
ReactEventHandler<T> | undefined
```
onSeekingCapture
```
ReactEventHandler<T> | undefined
```
onSelect
```
ReactEventHandler<T> | undefined
```
onSelectCapture
```
ReactEventHandler<T> | undefined
```
onStalled
```
ReactEventHandler<T> | undefined
```
onStalledCapture
```
ReactEventHandler<T> | undefined
```
onSubmit
```
SubmitEventHandler<T> | undefined
```
onSubmitCapture
```
SubmitEventHandler<T> | undefined
```
onSuspend
```
ReactEventHandler<T> | undefined
```
onSuspendCapture
```
ReactEventHandler<T> | undefined
```
onTimeUpdate
```
ReactEventHandler<T> | undefined
```
onTimeUpdateCapture
```
ReactEventHandler<T> | undefined
```
onToggle
```
ToggleEventHandler<T> | undefined
```
onTouchCancel
```
TouchEventHandler<T> | undefined
```
onTouchCancelCapture
```
TouchEventHandler<T> | undefined
```
onTouchEnd
```
TouchEventHandler<T> | undefined
```
onTouchEndCapture
```
TouchEventHandler<T> | undefined
```
onTouchMove
```
TouchEventHandler<T> | undefined
```
onTouchMoveCapture
```
TouchEventHandler<T> | undefined
```
onTouchStart
```
TouchEventHandler<T> | undefined
```
onTouchStartCapture
```
TouchEventHandler<T> | undefined
```
onTransitionCancel
```
TransitionEventHandler<T> | undefined
```
onTransitionCancelCapture
```
TransitionEventHandler<T> | undefined
```
onTransitionEnd
```
TransitionEventHandler<T> | undefined
```
onTransitionEndCapture
```
TransitionEventHandler<T> | undefined
```
onTransitionRun
```
TransitionEventHandler<T> | undefined
```
onTransitionRunCapture
```
TransitionEventHandler<T> | undefined
```
onTransitionStart
```
TransitionEventHandler<T> | undefined
```
onTransitionStartCapture
```
TransitionEventHandler<T> | undefined
```
onVolumeChange
```
ReactEventHandler<T> | undefined
```
onVolumeChangeCapture
```
ReactEventHandler<T> | undefined
```
onWaiting
```
ReactEventHandler<T> | undefined
```
onWaitingCapture
```
ReactEventHandler<T> | undefined
```
onWheel
```
WheelEventHandler<T> | undefined
```
onWheelCapture
```
WheelEventHandler<T> | undefined
```
open
```
boolean | undefined
```
optimum
```
number | undefined
```
part
```
string | undefined
```
pattern
```
string | undefined
```
placeholder
```
string | undefined
```
playsInline
```
boolean | undefined
```

popover

"" | "auto" | "manual" | "hint" | undefined

popoverTarget
```
string | undefined
```
popoverTargetAction
```
"toggle" | "show" | "hide" | undefined
```
poster
```
string | undefined
```
prefix
```
string | undefined
```
preload
```
string | undefined
```
property
```
string | undefined
```
radioGroup
```
string | undefined
```
readOnly
```
boolean | undefined
```
ref
Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref).
```
Ref<T> | undefined
```
rel
```
string | undefined
```
required
```
boolean | undefined
```
resource
```
string | undefined
```
results
```
number | undefined
```
rev
```
string | undefined
```
reversed
```
boolean | undefined
```
role
```
AriaRole | undefined
```
rows
```
number | undefined
```
rowSpan
```
number | undefined
```
sandbox
```
string | undefined
```
scope
```
string | undefined
```
scoped
```
boolean | undefined
```
scrolling
```
string | undefined
```
seamless
```
boolean | undefined
```
security
```
string | undefined
```
selected
```
boolean | undefined
```
shape
```
string | undefined
```
size
```
number | undefined
```
sizes
```
string | undefined
```
slot
```
string | undefined
```
span
```
number | undefined
```
spellCheck
```
Booleanish | undefined
```
src
```
string | undefined
```
srcDoc
```
string | undefined
```
srcLang
```
string | undefined
```
srcSet
```
string | undefined
```
start
```
number | undefined
```
step
```
number | string | undefined
```
style
```
CSSProperties | undefined
```
summary
```
string | undefined
```
suppressContentEditableWarning
```
boolean | undefined
```
suppressHydrationWarning
```
boolean | undefined
```
tabIndex
```
number | undefined
```
target
Where to display the url
```
Target
```
title
```
string | undefined
```
translate
```
"yes" | "no" | undefined
```
type
```
string | undefined
```
typeof
```
string | undefined
```
unselectable
```
"on" | "off" | undefined
```
url
The url to link to
```
string
```
useMap
```
string | undefined
```

value

string | readonly string[] | number | undefined

vocab
```
string | undefined
```
width
```
number | string | undefined
```
wmode
```
string | undefined
```
wrap
```
string | undefined
```

CrossOrigin

'anonymous' | 'use-credentials' | '' | undefined

Key

Backspace
```
8
```
Tab
```
9
```
Enter
```
13
```
Shift
```
16
```
Ctrl
```
17
```
Alt
```
18
```
Pause
```
19
```
CapsLock
```
20
```
Escape
```
27
```
Space
```
32
```
PageUp
```
33
```
PageDown
```
34
```
End
```
35
```
Home
```
36
```
LeftArrow
```
37
```
UpArrow
```
38
```
RightArrow
```
39
```
DownArrow
```
40
```
Insert
```
45
```
Delete
```
46
```
Key0
```
48
```
Key1
```
49
```
Key2
```
50
```
Key3
```
51
```
Key4
```
52
```
Key5
```
53
```
Key6
```
54
```
Key7
```
55
```
Key8
```
56
```
Key9
```
57
```
KeyA
```
65
```
KeyB
```
66
```
KeyC
```
67
```
KeyD
```
68
```
KeyE
```
69
```
KeyF
```
70
```
KeyG
```
71
```
KeyH
```
72
```
KeyI
```
73
```
KeyJ
```
74
```
KeyK
```
75
```
KeyL
```
76
```
KeyM
```
77
```
KeyN
```
78
```
KeyO
```
79
```
KeyP
```
80
```
KeyQ
```
81
```
KeyR
```
82
```
KeyS
```
83
```
KeyT
```
84
```
KeyU
```
85
```
KeyV
```
86
```
KeyW
```
87
```
KeyX
```
88
```
KeyY
```
89
```
KeyZ
```
90
```
LeftMeta
```
91
```
RightMeta
```
92
```
Select
```
93
```
Numpad0
```
96
```
Numpad1
```
97
```
Numpad2
```
98
```
Numpad3
```
99
```
Numpad4
```
100
```
Numpad5
```
101
```
Numpad6
```
102
```
Numpad7
```
103
```
Numpad8
```
104
```
Numpad9
```
105
```
Multiply
```
106
```
Add
```
107
```
Subtract
```
109
```
Decimal
```
110
```
Divide
```
111
```
F1
```
112
```
F2
```
113
```
F3
```
114
```
F4
```
115
```
F5
```
116
```
F6
```
117
```
F7
```
118
```
F8
```
119
```
F9
```
120
```
F10
```
121
```
F11
```
122
```
F12
```
123
```
NumLock
```
144
```
ScrollLock
```
145
```
Semicolon
```
186
```
Equals
```
187
```
Comma
```
188
```
Dash
```
189
```
Period
```
190
```
ForwardSlash
```
191
```
GraveAccent
```
192
```
OpenBracket
```
219
```
BackSlash
```
220
```
CloseBracket
```
221
```
SingleQuote
```
222
```

Target

'_blank' | '_self' | '_parent' | '_top'

Examples

/app/routes/**\/*.ts

import {authenticate} from '~/shopify.server';

import {AppProvider} from '@shopify/shopify-app-remix/react';

export async function loader({ request }) {

await authenticate.admin(request);

return json({ apiKey: process.env.SHOPIFY_API_KEY });

}

export default function App() {

const { apiKey } = useLoaderData();

return (

</AppProvider>

);

}

Examples

Description

Wrap your app in the `AppProvider` component and pass in your API key.

/app/routes/**\/*.ts

import {authenticate} from '~/shopify.server';
import {AppProvider} from '@shopify/shopify-app-remix/react';

export async function loader({ request }) {
  await authenticate.admin(request);

  return json({ apiKey: process.env.SHOPIFY_API_KEY });
}

export default function App() {
  const { apiKey } = useLoaderData();

  return (
    <AppProvider isEmbeddedApp apiKey={apiKey}>
      <Outlet />
    </AppProvider>
  );
}

Description

Pass in a different locale for Polaris to translate its components.

/app/routes/**\/*.ts

import {authenticate} from '~/shopify.server';
import {AppProvider} from '@shopify/shopify-app-remix/react';

export async function loader({ request }) {
  await authenticate.admin(request);

  return json({
    apiKey: process.env.SHOPIFY_API_KEY,
    polarisTranslations: require("@shopify/polaris/locales/fr.json"),
  });
}

export default function App() {
  const { apiKey, polarisTranslations } = useLoaderData();

  return (
    <AppProvider apiKey={apiKey} i18n={polarisTranslations}>
      <Outlet />
    </AppProvider>
  );
}

Anchor to RelatedRelated

Learn more about App Bridge.App bridge

Learn more about Polaris.Polaris

Was this page helpful?