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_PROVIDER_SPEC.md

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

Context Provider Specification

Complete specification for the EditorContextProvider manifest and all related types.

EditorContextProvider

Defines a context provider component that can be added to any page, container, or section in the Editor. The component is logical and does not provide any UI, but it does provide props for configuring it in the Editor.

Key Type Description Constraints
type string The component type, should be namespaced: slug.componentName Required, maxLength: 100
resources EditorContextProviderResources The runtime information needed for this component Required
context Context The exposed context model for this component Required
data map<propName: string, DataItem> The props this component can receive for configuration Required; use {} when there are no inputs
settings Action Allows overriding the default settings actions for the data of this component Optional
displayName string Human friendly name of the context provider for human readability Optional, maxLength: 50, translatable
description string The public description of the context provider Optional, maxLength: 300, translatable

EditorContextProviderResources

Defines the runtime resources needed for the context provider component.

Key Type Description Constraints
client Resource The ESM bundle URL for this component in runtime Required
editor Resource An ESM bundle for editor experiences. Can allow different things like having default data Optional
contextSpecifier ContextSpecifier The specifier of how to use the context this component provides in React Required
dependencies Dependencies Dependencies on other services and contexts Optional
schemaRefsUrl string URL A URL to get schema references of items for the function library Optional, internal

Resource

A resource specifier of where to load the ESM bundle from.

Key Type Description More Info
url String URL The URL to the ESM component bundle for server side rendering Should have the default export as the component

DataItem

Defines a single data item. Used in both the data map (configuration props) and within complex structures.

Key Type Description Constraints
dataType DataType The type of data Required
displayName string Display name of this data item Optional, maxLength: 100, translatable
defaultValue Value Default value (only for display purposes in editor panels). Should align with the runtime/props format Optional
deprecated boolean Whether this data item is deprecated Optional, internal
disableDeletion BoolValue Disables the ability to delete this data-item value in the Editor UI Optional
text Text Limitations on text input Only when dataType is text
textEnum TextEnum Required list of options Only when dataType is textEnum
number Number Restrictions on the number Only when dataType is number
a11y A11y List of A11Y attributes to configure Only when dataType is a11y
link Link Definition of supported link types Only when dataType is link
arrayItems ArrayItems Array type definition Required when dataType is arrayItems
data DataItems Complex data structure Required when dataType is data
image Image Image editing definition Only when dataType is image
video Video Video editing definition Only when dataType is video
vectorArt VectorArt SVG editing definition Only when dataType is vectorArt
richText RichText Rich text ability filters Only when dataType is richText
function EditorFunction Custom function definition Only when dataType is function
filter FilterDefinition Fields a WQL filter can use Required when dataType is filter
sort SortDefinition Fields a WQL sort can use Required when dataType is sort

The same disallowed data types that apply to context items also apply to data items (see Disallowed Data Types).

Filter and Sort Types

Data items only: a context item cannot be filter or sort (see Disallowed Data Types).

A filter data item needs a filter key, and a sort data item needs a sort key. Each holds up to three lists, and at least one must be non-empty:

Key Holds
inlineItems Fields described inline. Filter: name, displayName, dataType, optional operators. Sort: name, displayName, optional ascendingDisplayName / descendingDisplayName
dataItems References to other data items: { itemPath: { itemKey: '<key>' } }
contextItems References to context items: { itemPath: { itemKey: '<key>' } }

A missing key fails the checkpoint with dataType 'filter' must include a 'filter' field. An empty one (filter: {}) fails with must include at least one of 'inlineItems', 'dataItems', or 'contextItems'. TypeScript accepts both, because every field is optional.

productFilter: {
  dataType: 'filter',
  displayName: 'Product filter',
  filter: { inlineItems: [{ name: 'category', displayName: 'Category', dataType: 'text', operators: ['eq'] }] },
}

Text Type

Key Type Description
maxLength int32 Maximum length allowed for the text
minLength int32 Minimum length required for the text
pattern string A regex pattern the text must comply with (maxLength: 100)

TextEnum Type

Key Type Description
options Option[] List of valid enum items (minSize: 2, maxSize: 100)

A textEnum with fewer than 2 options fails the checkpoint with textEnum must have at least 2 options. A field that only ever holds one fixed value (e.g. a media type that is always 'image') is text, not a one-option textEnum. When changing a field from textEnum to text, remove its textEnum key too: a textEnum key on a non-textEnum item fails with dataType "text" does not match extension field "textEnum".

Each option:

Key Type Description
value string Actual text value (maxLength: 100, unique)
displayName string Display name (maxLength: 100, translatable)

Number Type

Key Type Description
min string Minimum value (string of Decimal number)
max string Maximum value (string of Decimal number)
multiplier string Multiplier for the number value (string of Decimal number)

RichText Type

Configuration for dataType: 'richText'. Only valid on DataItem (the data section). ContextItem does not accept this field — context richText items omit the config and receive all abilities by default.

Key Type Description
abilities RichTextAbilities[] Whitelist of formatting controls to expose in the editor. Omit to enable all. maxSize: 22

Runtime/props shape (from @wix/editor-react-types):

type RichText = {
  text: string;
  html: string;
  linkList: Array<Link>;
};
RichTextAbilities

font, fontFamily, fontSize, fontStyle, fontWeight, textDecoration, color, backgroundColor, letterSpacing, textAlign, direction, marginStart, marginEnd, bulletedList, numberedList, seoTag.

Example (DataItem)
{
  "dataType": "richText",
  "displayName": "Section Description",
  "defaultValue": "<p>Enter your section description here</p>",
  "richText": {
    "abilities": ["font", "color", "textAlign", "bulletedList"]
  }
}

defaultValue is an HTML string used for editor preview only. The runtime/props value received by the component is the RichText object shape above.

ArrayItems Type

⚠️ Important: This ArrayItems type is used in the data section only. In a context provider it takes dataItem as its key. This is different from ContextArrayItems (used in the context section), which uses item as its key. See ContextArrayItems below. A context provider array without dataItem or item fails the checkpoint with: arrayItems is missing arrayItems.item or arrayItems.dataItem with dataType.

Key Type Description
dataItem DataItem The type of each array element. Required in a context provider
maxSize int32 Maximum size of the array

arrayItems: { data: { items: {...} } } (a DataItems map directly under arrayItems) is valid for Editor React Components only. A context provider rejects it with the error above, after the build has already passed. For an array of objects, wrap the object in dataItem with dataType: 'data':

data: {
  sourceItems: {
    dataType: 'arrayItems',
    displayName: 'Source items',
    arrayItems: {
      dataItem: {
        dataType: 'data',
        data: {
          items: {
            title: { dataType: 'text', displayName: 'Title' },
            image: { dataType: 'text', displayName: 'Image URL' },
          },
        },
      },
    },
  },
},

DataItems Type

Key Type Description
items map<string, DataItem> Map of data items defining the complex object structure

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.