fubi 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +28 -38
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,47 +1,37 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Fubi
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Fubi is a lightweight, universal in-page feedback and collaboration tool. It allows users to leave contextual comments on specific elements of any web application, streamlining the feedback process for teams. For more information, visit [fubi.dev](https://fubi.dev).
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Features
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- 🎯 **Element Isolation**: Select and isolate specific page elements for targeted feedback
|
|
8
|
+
- 💬 **Threads and Comments**: Create comment threads attached to specific page elements
|
|
9
|
+
- ✅ **Mark as Done**: Track progress by marking feedback threads as completed
|
|
10
|
+
- 🔄 **Page Switcher**: Easily navigate between pages where feedback is provided
|
|
11
|
+
- ⚡ **Real-time Updates**: Get notified of new comments and changes instantly
|
|
12
|
+
- 🔌 **Easy Integration**: Simple to integrate into any web application
|
|
13
|
+
- 📦 **Tiny Footprint**: Lightweight package with minimal impact on your application
|
|
8
14
|
|
|
9
|
-
##
|
|
15
|
+
## Installation
|
|
10
16
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
**Why use this over SvelteKit?**
|
|
16
|
-
|
|
17
|
-
- It brings its own routing solution which might not be preferable for some users.
|
|
18
|
-
- It is first and foremost a framework that just happens to use Vite under the hood, not a Vite app.
|
|
19
|
-
|
|
20
|
-
This template contains as little as possible to get started with Vite + Svelte, while taking into account the developer experience with regards to HMR and intellisense. It demonstrates capabilities on par with the other `create-vite` templates and is a good starting point for beginners dipping their toes into a Vite + Svelte project.
|
|
21
|
-
|
|
22
|
-
Should you later need the extended capabilities and extensibility provided by SvelteKit, the template has been structured similarly to SvelteKit so that it is easy to migrate.
|
|
23
|
-
|
|
24
|
-
**Why `global.d.ts` instead of `compilerOptions.types` inside `jsconfig.json` or `tsconfig.json`?**
|
|
25
|
-
|
|
26
|
-
Setting `compilerOptions.types` shuts out all other types not explicitly listed in the configuration. Using triple-slash references keeps the default TypeScript setting of accepting type information from the entire workspace, while also adding `svelte` and `vite/client` type information.
|
|
27
|
-
|
|
28
|
-
**Why include `.vscode/extensions.json`?**
|
|
29
|
-
|
|
30
|
-
Other templates indirectly recommend extensions via the README, but this file allows VS Code to prompt the user to install the recommended extension upon opening the project.
|
|
31
|
-
|
|
32
|
-
**Why enable `checkJs` in the JS template?**
|
|
33
|
-
|
|
34
|
-
It is likely that most cases of changing variable types in runtime are likely to be accidental, rather than deliberate. This provides advanced typechecking out of the box. Should you like to take advantage of the dynamically-typed nature of JavaScript, it is trivial to change the configuration.
|
|
35
|
-
|
|
36
|
-
**Why is HMR not preserving my local component state?**
|
|
37
|
-
|
|
38
|
-
HMR state preservation comes with a number of gotchas! It has been disabled by default in both `svelte-hmr` and `@sveltejs/vite-plugin-svelte` due to its often surprising behavior. You can read the details [here](https://github.com/sveltejs/svelte-hmr/tree/master/packages/svelte-hmr#preservation-of-local-state).
|
|
17
|
+
```bash
|
|
18
|
+
npm install fubi
|
|
19
|
+
```
|
|
39
20
|
|
|
40
|
-
|
|
21
|
+
## Basic Usage
|
|
41
22
|
|
|
42
23
|
```js
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
24
|
+
import { fubi } from 'fubi';
|
|
25
|
+
|
|
26
|
+
// Initialize Fubi with your configuration
|
|
27
|
+
const app = fubi({
|
|
28
|
+
project: 'my-project',
|
|
29
|
+
content: "body", // any valid CSS selector
|
|
30
|
+
ignore: ["script", "style", "noscript", "br", "hr"], // array of elements to ignore
|
|
31
|
+
target: "body" // where to mount the Fubi container
|
|
32
|
+
});
|
|
47
33
|
```
|
|
34
|
+
|
|
35
|
+
## Getting Started
|
|
36
|
+
|
|
37
|
+
To use Fubi, you'll need to create an account at [fubi.dev](https://fubi.dev) where you can set up your projects and manage your feedback.
|