You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
<!-- Slogan -->
8
8
<palign="center">
9
-
A figma plugin boilerplate, that makes it easy building plugins with React + Vite!
9
+
Create scalable Figma plugins with ease, using the power of React + Vite!
10
10
</p>
11
11
12
12
<!-- Badges -->
@@ -32,15 +32,15 @@
32
32
33
33
## Key Features
34
34
35
-
1.**_Logical Sides in Mind:_** Figma plugins that render a UI works on two different processes (split into code.js and index.html in Figma docs). This boilerplate keeps sides separated, by allowing them to share code (under `./src/common/`).
35
+
1.**_Logical Sides in Mind:_** Figma plugins that render a UI work on two different processes (split into code.js and index.html in Figma docs). This boilerplate keeps the sides separated by allowing them to share code (under ./src/common/).
36
36
37
37
2.**_Intercommunitive:_** Logical sides should be able to communicate with each other without creating huge and unscalable nested if statements. This boilerplate solves it by declaring isolated messages (under `./src/common/network/messages/`)!
38
38
39
-
3.**_Easy to Build:_** Configure the vite config with your plugin credentials once, then just build with your everyday `npm run build` command! The `/dist` folder will be ready to publish already!
39
+
3.**_Easy to Build:_** Configure the `figma.manifest.ts` config with your plugin credentials once, then just build with your everyday `npm run build` command! The `/dist` folder will be ready to publish already!
40
40
41
-
4.**_Bundled into One File:_** Figma plugins only accept single file for main (js) and ui (html), which makes deployment of multiple files linked to each other impossible. This boilerplate is configured to bundle/inline most of the things you need like: rasterize/vector image asset imports, css url statements and of course source code imports.
41
+
4.**_Bundled into One File:_** Figma plugins only accept a single file for `main` (js) and `ui` (html), which makes deployment of multiple files linked to each other impossible. This boilerplate is configured to bundle/inline most of the things you need like rasterize/vector image asset imports, CSS URL statements, and of course, source code imports.
42
42
43
-
5.**_SVG as Component:_** Yes, you can import SVG's as inlined sources with `*.svg?inline`, but what about actually importing them as React components? Easy! You can import an svg file as React component with `*.svg?component`! (See `/src/ui/app.tsx` for examples)
43
+
5.**_SVG as Component:_** Yes, you can import SVGs as inlined sources with `*.svg?inline`, but what about actually importing them as React components? Easy! You can import an SVG file as a React component with `*.svg?component!` (See `/src/ui/app.tsx` for examples)
44
44
45
45
6.**_Sassy:_** A classic, this boilerplate supports Sass/Scss/Less and modules! Check out `/src/ui/styles/` for 7-1 Sass Template and `/src/ui/components/Button.module.scss` for module examples.
46
46
@@ -67,7 +67,7 @@ npm run dev
67
67
68
68
### Building
69
69
70
-
Building by the following command line will yield with a `dist` folder, which is ready to be used by Figma:
70
+
Building with the following command line will yield with a `dist` folder, which is ready to be used by Figma:
71
71
72
72
```
73
73
npm run build
@@ -94,7 +94,7 @@ After building, built `dist` folder is going to contain every artifact you need
94
94
95
95
### 1. Make sure to either inline or component SVG imports!
96
96
97
-
Importing image assets other than `.svg` is easy. However, when you are importing you MUST make sure it is imported using either one of the suffices`?inline` or `?component`.
97
+
Importing image assets other than `.svg` is easy. However, when you are importing `.svg`you MUST make sure it is imported using either one of the suffixes`?inline` or `?component`.
0 commit comments