--- title: AppProvider description: Sets up the Polaris AppProvider and injects the App Bridge script. api_version: v6 source_url: html: >- https://shopify.dev/docs/api/shopify-app-remix/latest/entrypoints/appprovider md: >- https://shopify.dev/docs/api/shopify-app-remix/latest/entrypoints/appprovider.md api_name: shopify-app-remix --- # App​Provider Sets up the Polaris `AppProvider` and injects the App Bridge script. This component extends the [`AppProvider`](https://polaris.shopify.com/components/utilities/app-provider) component from Polaris, and accepts all of its props except for `linkComponent`, which is overridden to use the Remix `Link` component. #### AppProviderProps * **i18n** **TranslationDictionary | TranslationDictionary\[]** **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 * **children** **React.ReactNode** Inner content of the application * **features** **FeaturesConfig** For toggling features * **link​Component** **LinkLikeComponent** A custom component to use for all links used by Polaris components * **theme** **ThemeName** ### FeaturesConfig * \[key: string] ```ts boolean | undefined ``` * dynamicTopBarAndReframe ```ts boolean ``` ### TranslationDictionary * \[key: string] ```ts string | TranslationDictionary ``` ### LinkLikeComponent ```ts React.ComponentType ``` ### LinkLikeComponentProps * \[key: string] ```ts any ``` * about ```ts string | undefined ``` * accept ```ts string | undefined ``` * acceptCharset ```ts string | undefined ``` * accessKey ```ts string | undefined ``` * action ```ts | string | undefined | ((formData: FormData) => void | Promise) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS[ keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS ] ``` * allowFullScreen ```ts boolean | undefined ``` * allowTransparency ```ts boolean | undefined ``` * alt ```ts string | undefined ``` * aria-activedescendant Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application. ```ts 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. ```ts 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. ```ts "none" | "inline" | "list" | "both" | undefined ``` * aria-braillelabel Defines a string value that labels the current element, which is intended to be converted into Braille. ```ts 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. ```ts string | undefined ``` * aria-busy Used to represent DOM API's where users can either pass true or false as a boolean or as its equivalent strings. ```ts Booleanish | undefined ``` * aria-checked Indicates the current "checked" state of checkboxes, radio buttons, and other widgets. ```ts boolean | "false" | "mixed" | "true" | undefined ``` * aria-colcount Defines the total number of columns in a table, grid, or treegrid. ```ts 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. ```ts number | undefined ``` * aria-colindextext Defines a human readable text alternative of aria-colindex. ```ts string | undefined ``` * aria-colspan Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid. ```ts number | undefined ``` * aria-controls Identifies the element (or elements) whose contents or presence are controlled by the current element. ```ts string | undefined ``` * aria-current Indicates the element that represents the current item within a container or set of related elements. ```ts boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined ``` * aria-describedby Identifies the element (or elements) that describes the object. ```ts string | undefined ``` * aria-description Defines a string value that describes or annotates the current element. ```ts string | undefined ``` * aria-details Identifies the element that provides a detailed, extended description for the object. ```ts string | undefined ``` * aria-disabled Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable. ```ts Booleanish | undefined ``` * aria-dropeffect Indicates what functions can be performed when a dragged object is released on the drop target. ```ts "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined ``` * aria-errormessage Identifies the element that provides an error message for the object. ```ts string | undefined ``` * aria-expanded Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed. ```ts 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. ```ts string | undefined ``` * aria-grabbed Indicates an element's "grabbed" state in a drag-and-drop operation. ```ts 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. ```ts boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined ``` * aria-hidden Indicates whether the element is exposed to an accessibility API. ```ts Booleanish | undefined ``` * aria-invalid Indicates the entered value does not conform to the format expected by the application. ```ts boolean | "false" | "true" | "grammar" | "spelling" | undefined ``` * aria-keyshortcuts Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element. ```ts string | undefined ``` * aria-label Defines a string value that labels the current element. ```ts string | undefined ``` * aria-labelledby Identifies the element (or elements) that labels the current element. ```ts string | undefined ``` * aria-level Defines the hierarchical level of an element within a structure. ```ts 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. ```ts "off" | "assertive" | "polite" | undefined ``` * aria-modal Indicates whether an element is modal when displayed. ```ts Booleanish | undefined ``` * aria-multiline Indicates whether a text box accepts multiple lines of input or only a single line. ```ts Booleanish | undefined ``` * aria-multiselectable Indicates that the user may select more than one item from the current selectable descendants. ```ts Booleanish | undefined ``` * aria-orientation Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous. ```ts "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. ```ts 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. ```ts 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. ```ts number | undefined ``` * aria-pressed Indicates the current "pressed" state of toggle buttons. ```ts boolean | "false" | "mixed" | "true" | undefined ``` * aria-readonly Indicates that the element is not editable, but is otherwise operable. ```ts Booleanish | undefined ``` * aria-relevant Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified. ```ts | "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. ```ts Booleanish | undefined ``` * aria-roledescription Defines a human-readable, author-localized description for the role of an element. ```ts string | undefined ``` * aria-rowcount Defines the total number of rows in a table, grid, or treegrid. ```ts 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. ```ts number | undefined ``` * aria-rowindextext Defines a human readable text alternative of aria-rowindex. ```ts string | undefined ``` * aria-rowspan Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid. ```ts number | undefined ``` * aria-selected Indicates the current "selected" state of various widgets. ```ts 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. ```ts number | undefined ``` * aria-sort Indicates if items in a table or grid are sorted in ascending or descending order. ```ts "none" | "ascending" | "descending" | "other" | undefined ``` * aria-valuemax Defines the maximum allowed value for a range widget. ```ts number | undefined ``` * aria-valuemin Defines the minimum allowed value for a range widget. ```ts number | undefined ``` * aria-valuenow Defines the current value for a range widget. ```ts number | undefined ``` * aria-valuetext Defines the human readable text alternative of aria-valuenow for a range widget. ```ts string | undefined ``` * as ```ts string | undefined ``` * async ```ts boolean | undefined ``` * autoCapitalize ```ts "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {}) ``` * autoComplete ```ts string | undefined ``` * autoCorrect ```ts string | undefined ``` * autoFocus ```ts boolean | undefined ``` * autoPlay ```ts boolean | undefined ``` * autoSave ```ts string | undefined ``` * capture ```ts boolean | "user" | "environment" | undefined ``` * cellPadding ```ts number | string | undefined ``` * cellSpacing ```ts number | string | undefined ``` * challenge ```ts string | undefined ``` * charSet ```ts string | undefined ``` * checked ```ts boolean | undefined ``` * children The content to display inside the link ```ts React.ReactNode ``` * cite ```ts string | undefined ``` * classID ```ts string | undefined ``` * className ```ts string | undefined ``` * color ```ts string | undefined ``` * cols ```ts number | undefined ``` * colSpan ```ts number | undefined ``` * content ```ts string | undefined ``` * contentEditable ```ts Booleanish | "inherit" | "plaintext-only" | undefined ``` * contextMenu ```ts string | undefined ``` * controls ```ts boolean | undefined ``` * coords ```ts string | undefined ``` * crossOrigin ```ts CrossOrigin ``` * dangerouslySetInnerHTML ```ts { // Should be InnerHTML['innerHTML']. // But unfortunately we're mixing renderer-specific type declarations. __html: string | TrustedHTML; } | undefined ``` * data ```ts string | undefined ``` * datatype ```ts string | undefined ``` * dateTime ```ts string | undefined ``` * default ```ts boolean | undefined ``` * defaultChecked ```ts boolean | undefined ``` * defaultValue ```ts string | number | readonly string[] | undefined ``` * defer ```ts boolean | undefined ``` * dir ```ts string | undefined ``` * disabled ```ts 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. ```ts string | boolean ``` * draggable Used to represent DOM API's where users can either pass true or false as a boolean or as its equivalent strings. ```ts Booleanish | undefined ``` * encType ```ts string | undefined ``` * enterKeyHint ```ts "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined ``` * exportparts ```ts string | undefined ``` * external Makes the link open in a new tab ```ts boolean ``` * form ```ts string | undefined ``` * formAction ```ts | string | undefined | ((formData: FormData) => void | Promise) | DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS[ keyof DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS ] ``` * formEncType ```ts string | undefined ``` * formMethod ```ts string | undefined ``` * formNoValidate ```ts boolean | undefined ``` * formTarget ```ts string | undefined ``` * frameBorder ```ts number | string | undefined ``` * headers ```ts string | undefined ``` * height ```ts number | string | undefined ``` * hidden ```ts boolean | undefined ``` * high ```ts number | undefined ``` * href ```ts string | undefined ``` * hrefLang ```ts string | undefined ``` * htmlFor ```ts string | undefined ``` * httpEquiv ```ts string | undefined ``` * id ```ts string | undefined ``` * inert ```ts boolean | undefined ``` * inlist ```ts any ``` * inputMode Hints at the type of data that might be entered by the user while editing the element or its contents ```ts "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined ``` * integrity ```ts string | undefined ``` * is Specify that a standard HTML element should behave like a defined custom built-in element ```ts string | undefined ``` * itemID ```ts string | undefined ``` * itemProp ```ts string | undefined ``` * itemRef ```ts string | undefined ``` * itemScope ```ts boolean | undefined ``` * itemType ```ts string | undefined ``` * key A value which uniquely identifies a node among items in an array. ```ts Key | null | undefined ``` * keyParams ```ts string | undefined ``` * keyType ```ts string | undefined ``` * kind ```ts string | undefined ``` * label ```ts string | undefined ``` * lang ```ts string | undefined ``` * list ```ts string | undefined ``` * loop ```ts boolean | undefined ``` * low ```ts number | undefined ``` * manifest ```ts string | undefined ``` * marginHeight ```ts number | undefined ``` * marginWidth ```ts number | undefined ``` * max ```ts number | string | undefined ``` * maxLength ```ts number | undefined ``` * media ```ts string | undefined ``` * mediaGroup ```ts string | undefined ``` * method ```ts string | undefined ``` * min ```ts number | string | undefined ``` * minLength ```ts number | undefined ``` * multiple ```ts boolean | undefined ``` * muted ```ts boolean | undefined ``` * name ```ts string | undefined ``` * nonce ```ts string | undefined ``` * noValidate ```ts boolean | undefined ``` * onAbort ```ts ReactEventHandler | undefined ``` * onAbortCapture ```ts ReactEventHandler | undefined ``` * onAnimationEnd ```ts AnimationEventHandler | undefined ``` * onAnimationEndCapture ```ts AnimationEventHandler | undefined ``` * onAnimationIteration ```ts AnimationEventHandler | undefined ``` * onAnimationIterationCapture ```ts AnimationEventHandler | undefined ``` * onAnimationStart ```ts AnimationEventHandler | undefined ``` * onAnimationStartCapture ```ts AnimationEventHandler | undefined ``` * onAuxClick ```ts MouseEventHandler | undefined ``` * onAuxClickCapture ```ts MouseEventHandler | undefined ``` * onBeforeInput ```ts InputEventHandler | undefined ``` * onBeforeInputCapture ```ts InputEventHandler | undefined ``` * onBeforeToggle ```ts ToggleEventHandler | undefined ``` * onBlur ```ts FocusEventHandler | undefined ``` * onBlurCapture ```ts FocusEventHandler | undefined ``` * onCanPlay ```ts ReactEventHandler | undefined ``` * onCanPlayCapture ```ts ReactEventHandler | undefined ``` * onCanPlayThrough ```ts ReactEventHandler | undefined ``` * onCanPlayThroughCapture ```ts ReactEventHandler | undefined ``` * onChange ```ts ChangeEventHandler | undefined ``` * onChangeCapture ```ts ChangeEventHandler | undefined ``` * onClick ```ts MouseEventHandler | undefined ``` * onClickCapture ```ts MouseEventHandler | undefined ``` * onCompositionEnd ```ts CompositionEventHandler | undefined ``` * onCompositionEndCapture ```ts CompositionEventHandler | undefined ``` * onCompositionStart ```ts CompositionEventHandler | undefined ``` * onCompositionStartCapture ```ts CompositionEventHandler | undefined ``` * onCompositionUpdate ```ts CompositionEventHandler | undefined ``` * onCompositionUpdateCapture ```ts CompositionEventHandler | undefined ``` * onContextMenu ```ts MouseEventHandler | undefined ``` * onContextMenuCapture ```ts MouseEventHandler | undefined ``` * onCopy ```ts ClipboardEventHandler | undefined ``` * onCopyCapture ```ts ClipboardEventHandler | undefined ``` * onCut ```ts ClipboardEventHandler | undefined ``` * onCutCapture ```ts ClipboardEventHandler | undefined ``` * onDoubleClick ```ts MouseEventHandler | undefined ``` * onDoubleClickCapture ```ts MouseEventHandler | undefined ``` * onDrag ```ts DragEventHandler | undefined ``` * onDragCapture ```ts DragEventHandler | undefined ``` * onDragEnd ```ts DragEventHandler | undefined ``` * onDragEndCapture ```ts DragEventHandler | undefined ``` * onDragEnter ```ts DragEventHandler | undefined ``` * onDragEnterCapture ```ts DragEventHandler | undefined ``` * onDragExit ```ts DragEventHandler | undefined ``` * onDragExitCapture ```ts DragEventHandler | undefined ``` * onDragLeave ```ts DragEventHandler | undefined ``` * onDragLeaveCapture ```ts DragEventHandler | undefined ``` * onDragOver ```ts DragEventHandler | undefined ``` * onDragOverCapture ```ts DragEventHandler | undefined ``` * onDragStart ```ts DragEventHandler | undefined ``` * onDragStartCapture ```ts DragEventHandler | undefined ``` * onDrop ```ts DragEventHandler | undefined ``` * onDropCapture ```ts DragEventHandler | undefined ``` * onDurationChange ```ts ReactEventHandler | undefined ``` * onDurationChangeCapture ```ts ReactEventHandler | undefined ``` * onEmptied ```ts ReactEventHandler | undefined ``` * onEmptiedCapture ```ts ReactEventHandler | undefined ``` * onEncrypted ```ts ReactEventHandler | undefined ``` * onEncryptedCapture ```ts ReactEventHandler | undefined ``` * onEnded ```ts ReactEventHandler | undefined ``` * onEndedCapture ```ts ReactEventHandler | undefined ``` * onError ```ts ReactEventHandler | undefined ``` * onErrorCapture ```ts ReactEventHandler | undefined ``` * onFocus ```ts FocusEventHandler | undefined ``` * onFocusCapture ```ts FocusEventHandler | undefined ``` * onGotPointerCapture ```ts PointerEventHandler | undefined ``` * onGotPointerCaptureCapture ```ts PointerEventHandler | undefined ``` * onInput ```ts InputEventHandler | undefined ``` * onInputCapture ```ts InputEventHandler | undefined ``` * onInvalid ```ts ReactEventHandler | undefined ``` * onInvalidCapture ```ts ReactEventHandler | undefined ``` * onKeyDown ```ts KeyboardEventHandler | undefined ``` * onKeyDownCapture ```ts KeyboardEventHandler | undefined ``` * onKeyPress ```ts KeyboardEventHandler | undefined ``` * onKeyPressCapture ```ts KeyboardEventHandler | undefined ``` * onKeyUp ```ts KeyboardEventHandler | undefined ``` * onKeyUpCapture ```ts KeyboardEventHandler | undefined ``` * onLoad ```ts ReactEventHandler | undefined ``` * onLoadCapture ```ts ReactEventHandler | undefined ``` * onLoadedData ```ts ReactEventHandler | undefined ``` * onLoadedDataCapture ```ts ReactEventHandler | undefined ``` * onLoadedMetadata ```ts ReactEventHandler | undefined ``` * onLoadedMetadataCapture ```ts ReactEventHandler | undefined ``` * onLoadStart ```ts ReactEventHandler | undefined ``` * onLoadStartCapture ```ts ReactEventHandler | undefined ``` * onLostPointerCapture ```ts PointerEventHandler | undefined ``` * onLostPointerCaptureCapture ```ts PointerEventHandler | undefined ``` * onMouseDown ```ts MouseEventHandler | undefined ``` * onMouseDownCapture ```ts MouseEventHandler | undefined ``` * onMouseEnter ```ts MouseEventHandler | undefined ``` * onMouseLeave ```ts MouseEventHandler | undefined ``` * onMouseMove ```ts MouseEventHandler | undefined ``` * onMouseMoveCapture ```ts MouseEventHandler | undefined ``` * onMouseOut ```ts MouseEventHandler | undefined ``` * onMouseOutCapture ```ts MouseEventHandler | undefined ``` * onMouseOver ```ts MouseEventHandler | undefined ``` * onMouseOverCapture ```ts MouseEventHandler | undefined ``` * onMouseUp ```ts MouseEventHandler | undefined ``` * onMouseUpCapture ```ts MouseEventHandler | undefined ``` * onPaste ```ts ClipboardEventHandler | undefined ``` * onPasteCapture ```ts ClipboardEventHandler | undefined ``` * onPause ```ts ReactEventHandler | undefined ``` * onPauseCapture ```ts ReactEventHandler | undefined ``` * onPlay ```ts ReactEventHandler | undefined ``` * onPlayCapture ```ts ReactEventHandler | undefined ``` * onPlaying ```ts ReactEventHandler | undefined ``` * onPlayingCapture ```ts ReactEventHandler | undefined ``` * onPointerCancel ```ts PointerEventHandler | undefined ``` * onPointerCancelCapture ```ts PointerEventHandler | undefined ``` * onPointerDown ```ts PointerEventHandler | undefined ``` * onPointerDownCapture ```ts PointerEventHandler | undefined ``` * onPointerEnter ```ts PointerEventHandler | undefined ``` * onPointerLeave ```ts PointerEventHandler | undefined ``` * onPointerMove ```ts PointerEventHandler | undefined ``` * onPointerMoveCapture ```ts PointerEventHandler | undefined ``` * onPointerOut ```ts PointerEventHandler | undefined ``` * onPointerOutCapture ```ts PointerEventHandler | undefined ``` * onPointerOver ```ts PointerEventHandler | undefined ``` * onPointerOverCapture ```ts PointerEventHandler | undefined ``` * onPointerUp ```ts PointerEventHandler | undefined ``` * onPointerUpCapture ```ts PointerEventHandler | undefined ``` * onProgress ```ts ReactEventHandler | undefined ``` * onProgressCapture ```ts ReactEventHandler | undefined ``` * onRateChange ```ts ReactEventHandler | undefined ``` * onRateChangeCapture ```ts ReactEventHandler | undefined ``` * onReset ```ts ReactEventHandler | undefined ``` * onResetCapture ```ts ReactEventHandler | undefined ``` * onScroll ```ts UIEventHandler | undefined ``` * onScrollCapture ```ts UIEventHandler | undefined ``` * onScrollEnd ```ts UIEventHandler | undefined ``` * onScrollEndCapture ```ts UIEventHandler | undefined ``` * onSeeked ```ts ReactEventHandler | undefined ``` * onSeekedCapture ```ts ReactEventHandler | undefined ``` * onSeeking ```ts ReactEventHandler | undefined ``` * onSeekingCapture ```ts ReactEventHandler | undefined ``` * onSelect ```ts ReactEventHandler | undefined ``` * onSelectCapture ```ts ReactEventHandler | undefined ``` * onStalled ```ts ReactEventHandler | undefined ``` * onStalledCapture ```ts ReactEventHandler | undefined ``` * onSubmit ```ts SubmitEventHandler | undefined ``` * onSubmitCapture ```ts SubmitEventHandler | undefined ``` * onSuspend ```ts ReactEventHandler | undefined ``` * onSuspendCapture ```ts ReactEventHandler | undefined ``` * onTimeUpdate ```ts ReactEventHandler | undefined ``` * onTimeUpdateCapture ```ts ReactEventHandler | undefined ``` * onToggle ```ts ToggleEventHandler | undefined ``` * onTouchCancel ```ts TouchEventHandler | undefined ``` * onTouchCancelCapture ```ts TouchEventHandler | undefined ``` * onTouchEnd ```ts TouchEventHandler | undefined ``` * onTouchEndCapture ```ts TouchEventHandler | undefined ``` * onTouchMove ```ts TouchEventHandler | undefined ``` * onTouchMoveCapture ```ts TouchEventHandler | undefined ``` * onTouchStart ```ts TouchEventHandler | undefined ``` * onTouchStartCapture ```ts TouchEventHandler | undefined ``` * onTransitionCancel ```ts TransitionEventHandler | undefined ``` * onTransitionCancelCapture ```ts TransitionEventHandler | undefined ``` * onTransitionEnd ```ts TransitionEventHandler | undefined ``` * onTransitionEndCapture ```ts TransitionEventHandler | undefined ``` * onTransitionRun ```ts TransitionEventHandler | undefined ``` * onTransitionRunCapture ```ts TransitionEventHandler | undefined ``` * onTransitionStart ```ts TransitionEventHandler | undefined ``` * onTransitionStartCapture ```ts TransitionEventHandler | undefined ``` * onVolumeChange ```ts ReactEventHandler | undefined ``` * onVolumeChangeCapture ```ts ReactEventHandler | undefined ``` * onWaiting ```ts ReactEventHandler | undefined ``` * onWaitingCapture ```ts ReactEventHandler | undefined ``` * onWheel ```ts WheelEventHandler | undefined ``` * onWheelCapture ```ts WheelEventHandler | undefined ``` * open ```ts boolean | undefined ``` * optimum ```ts number | undefined ``` * part ```ts string | undefined ``` * pattern ```ts string | undefined ``` * placeholder ```ts string | undefined ``` * playsInline ```ts boolean | undefined ``` * popover ```ts "" | "auto" | "manual" | "hint" | undefined ``` * popoverTarget ```ts string | undefined ``` * popoverTargetAction ```ts "toggle" | "show" | "hide" | undefined ``` * poster ```ts string | undefined ``` * prefix ```ts string | undefined ``` * preload ```ts string | undefined ``` * property ```ts string | undefined ``` * radioGroup ```ts string | undefined ``` * readOnly ```ts 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). ```ts Ref | undefined ``` * rel ```ts string | undefined ``` * required ```ts boolean | undefined ``` * resource ```ts string | undefined ``` * results ```ts number | undefined ``` * rev ```ts string | undefined ``` * reversed ```ts boolean | undefined ``` * role ```ts AriaRole | undefined ``` * rows ```ts number | undefined ``` * rowSpan ```ts number | undefined ``` * sandbox ```ts string | undefined ``` * scope ```ts string | undefined ``` * scoped ```ts boolean | undefined ``` * scrolling ```ts string | undefined ``` * seamless ```ts boolean | undefined ``` * security ```ts string | undefined ``` * selected ```ts boolean | undefined ``` * shape ```ts string | undefined ``` * size ```ts number | undefined ``` * sizes ```ts string | undefined ``` * slot ```ts string | undefined ``` * span ```ts number | undefined ``` * spellCheck Used to represent DOM API's where users can either pass true or false as a boolean or as its equivalent strings. ```ts Booleanish | undefined ``` * src ```ts string | undefined ``` * srcDoc ```ts string | undefined ``` * srcLang ```ts string | undefined ``` * srcSet ```ts string | undefined ``` * start ```ts number | undefined ``` * step ```ts number | string | undefined ``` * style ```ts CSSProperties | undefined ``` * summary ```ts string | undefined ``` * suppressContentEditableWarning ```ts boolean | undefined ``` * suppressHydrationWarning ```ts boolean | undefined ``` * tabIndex ```ts number | undefined ``` * target Where to display the url ```ts Target ``` * title ```ts string | undefined ``` * translate ```ts "yes" | "no" | undefined ``` * type ```ts string | undefined ``` * typeof ```ts string | undefined ``` * unselectable ```ts "on" | "off" | undefined ``` * url The url to link to ```ts string ``` * useMap ```ts string | undefined ``` * value ```ts string | readonly string[] | number | undefined ``` * vocab ```ts string | undefined ``` * width ```ts number | string | undefined ``` * wmode ```ts string | undefined ``` * wrap ```ts string | undefined ``` ### CrossOrigin ```ts 'anonymous' | 'use-credentials' | '' | undefined ``` ### Key * Backspace ```ts 8 ``` * Tab ```ts 9 ``` * Enter ```ts 13 ``` * Shift ```ts 16 ``` * Ctrl ```ts 17 ``` * Alt ```ts 18 ``` * Pause ```ts 19 ``` * CapsLock ```ts 20 ``` * Escape ```ts 27 ``` * Space ```ts 32 ``` * PageUp ```ts 33 ``` * PageDown ```ts 34 ``` * End ```ts 35 ``` * Home ```ts 36 ``` * LeftArrow ```ts 37 ``` * UpArrow ```ts 38 ``` * RightArrow ```ts 39 ``` * DownArrow ```ts 40 ``` * Insert ```ts 45 ``` * Delete ```ts 46 ``` * Key0 ```ts 48 ``` * Key1 ```ts 49 ``` * Key2 ```ts 50 ``` * Key3 ```ts 51 ``` * Key4 ```ts 52 ``` * Key5 ```ts 53 ``` * Key6 ```ts 54 ``` * Key7 ```ts 55 ``` * Key8 ```ts 56 ``` * Key9 ```ts 57 ``` * KeyA ```ts 65 ``` * KeyB ```ts 66 ``` * KeyC ```ts 67 ``` * KeyD ```ts 68 ``` * KeyE ```ts 69 ``` * KeyF ```ts 70 ``` * KeyG ```ts 71 ``` * KeyH ```ts 72 ``` * KeyI ```ts 73 ``` * KeyJ ```ts 74 ``` * KeyK ```ts 75 ``` * KeyL ```ts 76 ``` * KeyM ```ts 77 ``` * KeyN ```ts 78 ``` * KeyO ```ts 79 ``` * KeyP ```ts 80 ``` * KeyQ ```ts 81 ``` * KeyR ```ts 82 ``` * KeyS ```ts 83 ``` * KeyT ```ts 84 ``` * KeyU ```ts 85 ``` * KeyV ```ts 86 ``` * KeyW ```ts 87 ``` * KeyX ```ts 88 ``` * KeyY ```ts 89 ``` * KeyZ ```ts 90 ``` * LeftMeta ```ts 91 ``` * RightMeta ```ts 92 ``` * Select ```ts 93 ``` * Numpad0 ```ts 96 ``` * Numpad1 ```ts 97 ``` * Numpad2 ```ts 98 ``` * Numpad3 ```ts 99 ``` * Numpad4 ```ts 100 ``` * Numpad5 ```ts 101 ``` * Numpad6 ```ts 102 ``` * Numpad7 ```ts 103 ``` * Numpad8 ```ts 104 ``` * Numpad9 ```ts 105 ``` * Multiply ```ts 106 ``` * Add ```ts 107 ``` * Subtract ```ts 109 ``` * Decimal ```ts 110 ``` * Divide ```ts 111 ``` * F1 ```ts 112 ``` * F2 ```ts 113 ``` * F3 ```ts 114 ``` * F4 ```ts 115 ``` * F5 ```ts 116 ``` * F6 ```ts 117 ``` * F7 ```ts 118 ``` * F8 ```ts 119 ``` * F9 ```ts 120 ``` * F10 ```ts 121 ``` * F11 ```ts 122 ``` * F12 ```ts 123 ``` * NumLock ```ts 144 ``` * ScrollLock ```ts 145 ``` * Semicolon ```ts 186 ``` * Equals ```ts 187 ``` * Comma ```ts 188 ``` * Dash ```ts 189 ``` * Period ```ts 190 ``` * ForwardSlash ```ts 191 ``` * GraveAccent ```ts 192 ``` * OpenBracket ```ts 219 ``` * BackSlash ```ts 220 ``` * CloseBracket ```ts 221 ``` * SingleQuote ```ts 222 ``` ### Target ```ts '_blank' | '_self' | '_parent' | '_top' ``` ### Examples * #### Set up AppProvider ##### Description Wrap your app in the \`AppProvider\` component and pass in your API key. ##### /app/routes/\*\*\\/\*.ts ```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 ( ); } ``` * #### Localize Polaris components ##### Description Pass in a different locale for Polaris to translate its components. ##### /app/routes/\*\*\\/\*.ts ```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 ( ); } ``` *** ## Related [Learn more about App Bridge. - App bridge](https://shopify.dev/docs/api/app-bridge-library) [Learn more about Polaris. - Polaris](https://shopify.dev/docs/apps/tools/polaris) ***