Skip to main content
A standalone Widget Package belongs to an existing Droplet and publishes widget code and metadata for that Droplet. The generated project uses defineWidgetPackage and startWidgetPackage from the supported worker SDK.

Create the project

You can link an existing Droplet during creation:
If the project is not linked yet:
The command writes the selected Droplet ID to fluid.widget.config.ts. It does not change the package identity, version, or widget registrations in manifest.ts.

Start development

The development server normally runs at http://localhost:5174. Preview the package through a portal or builder. The command does not start a separate preview application.

Validate and build

Render the built package through a portal or builder. A successful build cannot verify appearance, accessibility, or theme behavior.

Publish

Increment the semantic version in manifest.ts, then run:
fluid widget push commits and pushes your source to the package’s repository on Fluid, then builds and publishes. Publication creates an immutable Droplet widget version. Use a new version for every published change. See Validate, build, and publish for how push differs from the template’s widget:publish script.

When the package appears in a portal

A published Droplet package appears in a company’s Portal Builder Widgets tab and portal only when all of these are true:
  1. The company has installed the Droplet, and the installation is active. When the company uninstalls it, its widgets leave the catalog.
  2. The Droplet isn’t a draft, archived or suspended.
  3. The package has a published version. Publishing approves the upload automatically when its files check out.
The company sees none of these from the portal. When a widget doesn’t show up, check them in this order. A company package needs no Droplet or installation, so use one for widgets that only your own company’s portal needs. See Choose a model.