Index of every page on this site: llms.txt
All skills
wix avatar

/wix-app

@e2bc48e official
by Wix.comwix/skills40 stars
42
Run it yourself

Build and review Wix CLI app extensions — dashboard pages, modals, plugins, menu plugins, custom element widgets, Editor React components, site plugins, embedded scripts, context providers, function libraries, lightbox (popup) behavior, page onLoad contexts, backend APIs, backend events, service plugins, data collections, and App Market readiness. Use when building ANY feature or extension for a Wix CLI app or preparing a Wix app for App Market review. Triggers on: add, build, create, implement, help me, dashboard, widget, plugin, backend, API, event, collection, embedded script, service plugin, Editor React component, context provider, function library, onLoad, on page load, checkout, shipping, tax, discount, SPI, CMS, schema, tracking, popup, lightbox, admin panel, menu item, modal, validate, test, verify, register extension, App Market, app review, submission readiness.

Use this Skill: https://skilld.dev/gh/wix/skills/wix-app

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

referencescontext-providerCONTEXT_SPEC_ITEMS.md

≈2.1k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Context Provider Specification: Context and Items

Context

Defines the context model exposed by the context provider component.

Key Type Description Constraints
items map<string, ContextItem> A map of keys describing the context provided by this component Required

ContextSpecifier

Specifies how to use the context this component provides in React.

Key Type Description Constraints
moduleSpecifier string An identifier for the context module. Does not have to be an NPM package. Unique across all of Wix, so it must be <moduleSpecifierPrefix><provider-kebab-case-name> (@/ by default, or the prefix the user gives you). Cannot be renamed once registered Required, must start with <moduleSpecifierPrefix>, maxLength: 100
hook string The exported hook for components usage (e.g., useSomeContextName) Required, maxLength: 100

ContextItem

Defines a single context item that can be provided by the context provider.

Key Type Description Constraints
dataType DataType The type exposed by the context item Required
displayName string The display name of the context item for user facing and AI usage Optional, maxLength: 100, translatable
description string A description of the context item for user facing and AI usage Optional, maxLength: 300, translatable
contextImplementor ContextImplementor For sub types that implement parts of context, points to a context provider component type Optional
arrayItems ContextArrayItems For arrays, the items are defined here Only used when dataType is arrayItems
data ContextDataItems For data objects, the items are defined here Only used when defining a complex object structure
function EditorFunction For functions, the function definition is defined here Only used when dataType is function
textEnum TextEnum A required list of options to supply to the users to choose from Only used when dataType is textEnum
deprecated boolean Will be set to true in case an item has been removed from the Context Optional, internal

Disallowed Data Types

The following dataTypes are NOT allowed for context items or data props:

  • UNKNOWN_DataType
  • schema
  • container
  • onClick (deprecated — expose a function item and let the element's click handler bind to it)
  • onChange (deprecated — expose a function item and let the element's change handler bind to it)
  • onKeyPress (deprecated)
  • onKeyUp (deprecated)
  • onKeyDown (deprecated)
  • onFocus (deprecated)
  • onSubmit (deprecated)

filter and sort are not allowed for context items either, at any depth (context.items, or inside a context item's data or arrayItems). A context item has no filter or sort field, so the definition never reaches the checkpoint: it fails with dataType 'filter' must include a 'filter' field even when the source declares filter: {...}, and no edit to the definition fixes it. To let the page filter by a visitor's choice, expose the choice itself: a text or textEnum item such as selectedCategoryId, plus a function item that sets it. The provider applies the filter to its own query and exposes the filtered list as arrayItems.

DataType is a closed enum: every dataType — on context items, data items, function parameters and return types — must be one of the values in the table below. The checkpoint validates the manifest against this enum and rejects anything else with INVALID_ARGUMENT (value 'pointerEvent' does not match any of the allowed values), after the build has already passed. A function bound to an element's event handler declares parameters: []; the DOM event is not a parameter and has no data type.

Available Data Types

Type Runtime Value Use Case
text string Names, IDs, labels
textEnum string Predefined option sets
number number Counts, quantities, dimensions
booleanValue boolean Toggles, flags
a11y object Accessibility attributes
link { href, target, rel } Navigation links
image Image object Image data
video Video object Media content
vectorArt SVG object Icons, graphics
audio Audio object Audio content
localDate string (YYYY-MM-DD) Date values
localTime string (hh:mm[:ss][.sss]) Time values
localDateTime string (YYYY-MM-DDThh:mm[:ss][.sss]) Date-time values
webUrl string URLs (http/https)
email string Email addresses (RFC 5321)
phone string Phone numbers
hostname string Hostname (IANA)
regex string Regex patterns
guid string Unique identifiers
richText RichText from @wix/editor-react-types ({ text, html, linkList }) Formatted content with inline styles
arrayItems Array Lists, collections
direction string HTML dir attribute (ltr/rtl)
menuItems Array Menu item collections
data object Complex nested objects
function function Actions, callbacks
filter object WQL filter. Data items only, never a context item (see Filter and Sort Types)
sort array WQL sort definition. Data items only, never a context item (see Filter and Sort Types)

Link configuration

For a link item or parameter, the optional link field limits the link types a Wix user can pick in the editor:

Field Required Description
linkTypes No Allowed link types. Defaults to all supported types.
appIds No App IDs available for dynamicPageLink and pageLink values.
hideInnerRoute No Whether a dynamic page link can target only a top-level page.
{ dataType: 'link', displayName: 'Destination', link: { linkTypes: ['externalLink', 'pageLink'] } }

ContextImplementor

A Context Implementor definition allows any part of a context to be delegated to a separate component. The referenced component provides a new context and may provide additional functionality that relies on the data from the original parent context. It may even use functionality from the parent to update its state.

This pattern is useful when an item-level context needs to provide functions that modify parent state (e.g., setAsCurrentItem, removeItem, updateQuantity).

When a contextImplementor is specified on a ContextItem or within ContextDataItems, the system will look for the referenced component (by componentType) in the component tree and delegate that portion of the context to it. The optional propKey specifies which prop the implementor component expects the context value to be passed through.

A context implementor must be part of the same application.

Key Type Description Constraints
componentType string The component type that implements this part of the context. Must reference a valid registered component type of the same app Required, maxLength: 100
propKey string The prop key the implementor component expects the context to be passed in to it Optional, maxLength: 100

ContextArrayItems

Defines the structure of array items in the context. Specifies the type of data inside the array using a ContextItem, which can represent simple types, complex objects, nested arrays, or functions.

Key Type Description Constraints
item ContextItem Specifies the type of data inside the array Required

ContextDataItems

A map of keys describing the context items provided by this component. Used for defining complex object structures in context.

Key Type Description Constraints
items map<string, ContextItem> A map of keys describing the data items provided by this component Required
contextImplementor ContextImplementor For sub types that implement parts of context, points to a context provider component type Optional

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

2 warningstoday4 checks · Risk SAFE
  • Gen Agent Trust Hubtoday

    This skill provides a comprehensive environment and set of tools for building Wix CLI app extensions. It includes detailed instructions, API references, and local utility scripts for development tasks like SDK lookup and accessibility auditing. All operations and dependencies are standard for the Wix developer platform.

  • Sockettoday

    1 alert: gptAnomaly

  • Snyktoday

    Risk: MEDIUM · 1 issue

  • ZeroLeaks7mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at e2bc48e. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub yesterday.

Activeupdated 6 days ago
compatibility
requires `@wix/cli` >= 1.1.192.

README badge

README badge for wix/skills/wix-app

Builds dashboard pages, modals, plugins, custom widgets, Editor React components, backend APIs, events, service plugins, and data collections for Wix CLI apps. Provides decision logic, API patterns, and validation workflows; scaffolding is owned by the Wix CLI via `wix generate --params`.

Generated from the current SKILL.md.

What extension types does this skill cover?
All Wix CLI app extension types: dashboard pages, modals, plugins, menu plugins, custom element widgets, Editor React components, site plugins, embedded scripts, backend APIs, backend events, service plugins, and data collections.
Does this skill scaffold the extension files for me?
The Wix CLI owns scaffolding via `wix generate --params` for all extension types except Backend API. This skill provides decision logic, API guidance, and business-logic patterns to fill in the generated stubs. Backend API files must be created manually.
What Wix CLI version is required?
The skill requires @wix/cli >= 1.1.192.
Do I need to create a Data Collection extension for app-specific data?
Yes, if you're saving or persisting app-specific data, managing domain entities in a dashboard, or running a service plugin that reads app-configured data. The skill infers this automatically—you don't need to explicitly request it.
Does this skill cover Wix Stores API usage?
Yes. When using any Wix Stores API (products, inventory, orders), the skill requires dual V1/V3 catalog support and references the Stores Versioning guide for module selection and field mapping.

Generated from the current SKILL.md. These answers refresh after source changes.