Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add JS plugin getting started #5204

Merged
merged 1 commit into from
Dec 2, 2024
Merged

add JS plugin getting started #5204

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/source/plugins/developing_plugins.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,9 @@ directory.

.. note::

For vite configs we recommend forking the
`FiftyOne Plugins <https://github.com/voxel51/hello-world-plugin-js>`_
repository and following the conventions there to build your plugin.
For JS plugins we recommend forking the
`FiftyOne Hello World JS Example <https://github.com/voxel51/hello-world-plugin-js>`_
repository and following the conventions there to build your JS plugin.

.. _plugin-anatomy:

Expand Down Expand Up @@ -3132,6 +3132,18 @@ _____________________

This section describes how to develop JS-specific plugin components.

Getting Started
---------------

To start building your own JS plugin, refer to the
`hello-world-plugin-js <https://github.com/voxel51/hello-world-plugin-js>`_
repository. This repo serves as a starting point, providing examples of a build
process, a JS panel, and a JS operator.

The `fiftyone-js-plugin-build <https://github.com/voxel51/fiftyone-js-plugin-build>`_
package offers a utility for configuring `vite <https://vite.dev>`_ to build your
JS plugin bundle.

Component types
---------------

Expand Down
Loading