astro-feelback
v0.3.4
Published
Use Feelback service within your Astro website
Downloads
484
Maintainers
Readme
Feelback Astro integration library
This package is the Astro SDK of the Feelback service, which includes:
- builtin components with presets ready to use in your pages
- a javascript client for easy interaction with the Feelback API, useful for building custom components
- predefined styling you can adopt for nice-looking components with no effort
Prerequisite
- node 16+
- astro 1.9+
Installation
Add the package with your package manager of choice:
npm install astro-feelback
# or
pnpm add astro-feelback
# or
yarn add astro-feelback
Example
After the package is installed, you can import components:
---
import FeelbackPulse from "astro-feelback/components/FeelbackPulse.astro";
interface Props = {
title: string
}
const { title } = Astro.props;
---
<div>
<h1>{title}</h1>
<FeelbackPulse contentSetId="content-set-id-from-panel" icon="heart" showCount />
</div>
Style
The package provides a predefined style you can import:
---
import "astro-feedback/styles/feelback.css";
---
<html>
...
</html>
Project example
Checkout the sample project astro-docs for a concrete Feelback integration and several usage examples.
Additional resources
- Read the full integration guide
- Checkout the official documentation with a full overview of the Feelback service
Types
This package is built in typescript so it has full typings support.