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-providervertical-contextsblogpost-by-id.md

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

Blog context: @wix/blog/context/post-by-id (part 1 of 2)

This context's reference is split across 2 files: post-by-id.md, post-by-id-2.md.

Read Importing a Context in Code first. Import only the hook, from @wix/blog/context/post-by-id.

PostByIdProvider

Supplies the blog post picked by ID through the Post context.

import { PostByIdProvider } from '@wix/blog/context/post-by-id';
  • Parameters: __0: PostByIdProviderProps
  • Returns: ReactNode

usePostByIdContext

Reads the current post from the nearest Post context provider; throws outside one.

import { usePostByIdContext } from '@wix/blog/context/post-by-id';
  • Parameters: none
  • Returns: PostContextType
Returned types
PostByIdProviderProps
Property Type Description
children ReactNode
postPicker PostPickerFilter | undefined The manifest's data.postPicker filter — { postId: { $eq: '<id>' } } once picked.
PostContextType
Property Type Description
title RichText The post's title, as rich text: title.text is the plain text, and title.html is the same text in an HTML paragraph.
excerpt RichText A short summary of the post, as rich text. To check whether there is one, use hasExcerpt.
coverImage Image | undefined The post's cover image, or the poster image of its video cover, as an Image from @wix/editor-react-types. undefined when the post has neither. It holds the image even when the post's author hid the cover, so check hasCoverImage before you show it.
richContent RichContent The post's full body, as a Ricos rich content document. Show it with a rich content viewer. When the post is for paying subscribers only and the site visitor can't read all of it, the body ends where the free part ends, followed by the post's paywall message.
authorName RichText The display name of the post's author, as rich text.
authorImage Image | undefined The profile picture of the post's author, as an Image from @wix/editor-react-types. undefined when the author has none.
timeToRead RichText The post's estimated reading time with its unit, such as 3 min read, as rich text in the site's language. Empty when the post has no estimate.
publishedDate RichText The date the post was first published, as rich text in the site's regional format: a relative date in the last week, such as 3 days ago, and the calendar date after that, such as May 12, with the year when it isn't the current year, such as May 12, 2024.
viewCount RichText The post's view count with its unit, such as 340 views, as rich text. Empty when there's no count to show.
commentCount RichText The post's comment count with its unit, such as 4 comments, as rich text. Empty when there's no count to show.
likeCount RichText The post's like count with its unit, such as 12 likes, as rich text. Includes a like or unlike from toggleLike(). Empty when there's no count to show.
postCategories PostCategoryItem[] The categories the post belongs to, in the post's order. Empty when it has none.
postTags PostTagItem[] The post's tags, in the post's order. Empty when it has none.
hasCoverImage boolean Whether the post shows a cover image, or a video cover with a poster image. false when the post's author hid the cover. true in the editor when there's no post, so that sample content stays visible.
hasExcerpt boolean Whether the post has an excerpt that isn't empty. true in the editor when there's no post.
hasTags boolean Whether the post has at least one tag. true in the editor when there's no post.
publishedDateValue string | undefined The date and time the post was first published, as an ISO 8601 string. undefined when there's no date to show. To format it as a relative date, use clockValue as the current time.
minutesToReadValue number | undefined The post's estimated reading time, in minutes. undefined when the post has no estimate.
viewCountValue number | undefined The post's view count. undefined when there's no count to show. Updates when the current count loads in the browser.
commentCountValue number | undefined The number of comments on the post. undefined when there's no count to show. Updates when the current count loads in the browser.
isLiked boolean Whether the site visitor liked the post. false until the visitor's like state loads in the browser. Changes when you call toggleLike(). To read the change without delay, use liveLikes.
likeCountValue number Number of likes the post has, including a like or unlike from toggleLike(). Until isLikeCountLoaded is true, this is the count the page rendered with, which can be out of date, or 0 when that count isn't available. For the count with its unit, such as 12 likes, use likeCount.
isLikeCountLoaded boolean Whether likeCountValue is final. false on the server, and in the browser while the current count loads. true once the count loads or fails to load, and when there's no count to load, such as when there's no post or in the editor's Preview mode. It stays false after an error that stops the post from rendering. isEmpty is then true, so check isEmpty first.
toggleLike (pointerEvent?: PointerEvent | undefined) => Promise<void> Likes the post for the site visitor, or removes their like if they already liked it. isLiked, likeCountValue, and likeCount change, and so do the values of other components on the page that show the same post. If saving the change fails, they change back. In the editor's Preview mode, the change isn't saved. Does nothing when there's no post, or while a previous call is still saving.
liveLikes LiveLikes | undefined The site visitor's like state and the post's counts, without delay. isLiked, likeCountValue, isLikeCountLoaded, viewCountValue, and commentCountValue update in a React transition, so they can lag behind while other parts of the page are still loading. To show changes without that delay, read the values with liveLikes.get(), and listen for changes with liveLikes.subscribe(). undefined while the post loads, and after an error that stops the post from rendering.
clockValue number The time publishedDate measures relative dates from, such as 3 days ago, in milliseconds since the Unix epoch. When you format publishedDateValue yourself, use it as the current time, so that your text matches publishedDate. 0 while the post loads.
postUrl string | undefined Absolute URL of the post's page on the site, such as for a share button. undefined when there's no URL to share, such as while the post loads or when there's no post.
relatedPostsSource RelatedPostsSource IDs used to pick the posts related to this post: the post's own ID, its category IDs, and the related posts its author chose. The object stays the same when the like state changes, so you can use it as an effect dependency.
isLoadingPost boolean Whether the post is still loading. While it's true, the other properties are empty. Use it to show a placeholder instead of empty content.
hasError boolean Whether an error stopped the post from rendering. When it's true, the properties don't hold the post's content, and isEmpty is true. A post that fails to load isn't an error: hasError is false, and isEmpty is true, except in the editor, but not in Preview, where the properties hold sample values.
isEmpty boolean Whether there's no post to show, such as when the Wix user hasn't chosen a post in the Selected Post Data Source's settings, or the chosen post isn't published or couldn't be loaded. Use it to hide the component, instead of showing empty text and a 0 count. false while the post loads. Also false in the editor outside Preview mode, where the properties hold sample values, unless an error stopped the post from rendering.
Image
Property Type Description
uri string | undefined The image URI.
url string
name string | undefined
height number | undefined
width number | undefined
animated boolean | undefined
crop Crop | undefined
quality number | undefined
alt string | undefined
RichContent
Property Type Description
nodes Node[] | undefined Node objects representing a rich content document.
metadata Metadata | undefined Object metadata.
documentStyle DocumentStyle | undefined Global styling for header, paragraph, block quote, and code block nodes in the object.

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.