plasmo
    TypeScript icon, indicating that this package has built-in type declarations

    0.55.0 • Public • Published

    plasmo logo

    See License NPM Install Follow PlasmoHQ on Twitter Watch our Live DEMO every Friday Join our Discord for support and chat about our projects

    English | 简体中文 | Tiếng Việt | Deutsch | French

    Plasmo Framework

    The Plasmo Framework is a battery-packed browser extension SDK made by hackers for hackers. Build your product and stop worrying about config files and the odd peculiarities of building browser extensions.

    It's like Next.js for browser extensions!

    CLI Demo

    Features

    System Requirements

    • Node.js 16.x or later
    • MacOS, Windows, or Linux
    • (Strongly Recommended) pnpm

    Examples

    We have examples showcasing how one can use Plasmo with Firebase Authentication, Redux, Supabase authentication, Tailwind, and many more. To check them out, visit our examples repository.

    Documentation

    Check out the documentation to get a more in-depth view into the Plasmo Framework.

    Usage

    pnpm create plasmo example-dir
    cd example-dir
    pnpm dev
    

    The road ahead is filled with many turns.

    • Popup changes go in popup.tsx
    • Options page changes go in options.tsx
    • Content script changes go in content.ts
    • Background service worker changes go in background.ts

    Directories

    You can also organize these files in their own directories:

    ext-dir
    ├───assets
    |   └───icon512.png
    ├───popup
    |   ├───index.tsx
    |   └───button.tsx
    ├───options
    |   ├───index.tsx
    |   ├───utils.ts
    |   └───input.tsx
    ├───contents
    |   ├───site-one.ts
    |   ├───site-two.ts
    |   └───site-three.ts
    ...
    

    Finally, you can also avoid putting source code in your root directory by putting them in a src sub-directory, following this guide. Note that assets and other config files will still need to be in the root directory.

    Community

    The Plasmo community can be found on Discord. This is the appropriate channel to get help with using the Plasmo Framework.

    Our Code of Conduct applies to all Plasmo community channels.

    Contributing

    Please see the contributing guidelines to learn more.

    Disclaimer

    Plasmo is currently alpha software, and some things might change from version to version, so please be mindful and use it at your own risk.

    License

    MIT Plasmo

    Install

    npm i plasmo

    DownloadsWeekly Downloads

    2,300

    Version

    0.55.0

    License

    MIT

    Unpacked Size

    108 kB

    Total Files

    22

    Last publish

    Collaborators

    • louisgv
    • stayfun_