@onbeam/features

@onbeam/features

A collection of features built by combining components from @onbeam/ui and utils/hooks from @onbeam/utils, forming fully functioning ready to go features (for example handling cookie consent and wallet connections). It is necessary to setup @onbeam/styled-system when using this package, install all packages listed in the installation section and follow the PandaCSS setup steps.

Table of Contents

• @onbeam/features
  • Table of Contents
  • Installation
  • PandaCSS
    • Config
    • PostCSS
    • CSS
    • Scripts
  • Tree-Shaking Support
  • Examples
    • Example 1: Cookie consent
    • Example 2: Connect wallet button
  • All @onbeam packages

Installation

Install the packages using your preferred package manager:

pnpm add @onbeam/features
pnpm add @onbeam/styled-system@latest
pnpm add @pandacss/dev@latest --save-dev

To keep all @onbeam packages updated, you can use the CLI:

npx @onbeam/cli update -d [directory]

PandaCSS

Due to the component styles building just-in-time, you need to install and configure PandaCSS. This means that only the styles for the components you use will be generated, nothing more. When you decide to utilize PandaCSS in your own project, you will be able to use all design tokens and PandaCSS will combine the UI styles with your project styles before compiling the output.

Config

Create a panda.config.ts file in the root of your application and paste this snippet in there:

import { defineBeamUiConfig } from "@onbeam/styled-system/config";

export default defineBeamUiConfig({
  include: [
    "./node_modules/@onbeam/ui/dist/panda.buildinfo.json", // Only add this when you're using the @onbeam/ui package
    // TODO: Configure this line to target your own files that utilize the component library and PandaCSS
    "./src/**/*.{ts,tsx}",
  ],
});

PostCSS

Run npx panda init --postcss. This will create a postcss.config.cjs file in the root of your application with the following code:

module.exports = {
  plugins: {
    "@pandacss/dev/postcss": {},
  },
};

CSS

To enable the styles, create a global CSS file, for example named "globals.css" and paste the following snippet in there:

/* When adding libraries that could overwrite our styles, make sure to use css layers: */
/* https://panda-css.com/docs/overview/faq#how-can-i-prevent-other-libraries-from-overriding-my-styles */
@layer reset, base, tokens, recipes, utilities;

body {
  font-family: var(--beam-fonts-main);
  color: var(--beam-colors-mono-100);
}

/* TODO: These are all fonts used in the @onbeam/ui components, only add them if you are using @onbeam/ui. Add all your used fonts here */
@font-face {
  font-family: "Suisse Intl";
  font-style: normal;
  font-display: swap;
  font-weight: 400;
  src: url("../node_modules/@onbeam/ui/dist/fonts/SuisseIntl-Regular.otf");
}

@font-face {
  font-family: "Suisse Intl";
  font-style: normal;
  font-display: swap;
  font-weight: 500;
  src: url("../node_modules/@onbeam/ui/dist/fonts/SuisseIntl-Book.otf");
}

/* TODO: Remove this if you're not using the `ObjectTree` component */
@font-face {
  font-family: "JetBrains Mono";
  font-style: normal;
  font-display: swap;
  font-weight: 400;
  src: url("../node_modules/@onbeam/ui/dist/fonts/JetBrainsMono-Regular.ttf");
}

In the root of your project code, for example layout.tsx or _app.tsx, import your created css file:

import "./globals.css";

Scripts

To build the PandaCSS code, add the panda codegen command to your package.json's build script. For example:

"scripts": {
  "build": "panda codegen && next build",
},

Tree-Shaking Support

This package is fully tree-shakable, ensuring that only the features you import are included in your final bundle, optimizing your app's performance.

Examples

Example 1: Cookie consent

import { CookieConsent } from "@onbeam/features";

const AppLayout = ({ children }) => {
  return (
    <>
      {children}
      <CookieConsent
        consentDomain={
          process.env.NODE_ENV === "development" ? "localhost" : ".onbeam.com"
        }
      />
    </>
  );
};

Example 2: Connect wallet button

import { ConnectWalletButton } from "@onbeam/features";

const Header = () => {
  return (
    <div>
      <Logo />
      <ConnectWalletButton size="sm" />
    </div>
  );
};

For more examples, check out the docs of all features here.

All @onbeam packages

• @onbeam/automation-api-client
• @onbeam/biome-config
• @onbeam/cli
• @onbeam/errors
• @onbeam/features
• @onbeam/icons
• @onbeam/player-api-client
• @onbeam/sdk
• @onbeam/styled-system
• @onbeam/ui
• @onbeam/utils

That's it! Happy coding! 🌈