refactor: added some comments

editor-js · Mar 2, 2023 · d3f4b7d · d3f4b7d
1 parent 98e1fd6
commit d3f4b7d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -43,13 +43,19 @@ export default class Paragraph implements BlockTool {
    */
   private readonly element: HTMLDivElement;
 
+  /**
+   * CSS class names
+   */
   private readonly CSS: ParagraphToolCSS;
 
   /**
    * Placeholder for paragraph if it is first Block
    */
   private readonly placeholder: string;
 
+  /**
+   * Will save empty paragraphs if set to true
+   */
   private readonly preserveBlank: boolean;
 
   /**

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -22,6 +22,9 @@ export interface ParagraphToolConfig extends ToolConfig {
   preserveBlank?: boolean;
 }
 
+/**
+ * CSS class names for elements created by the plugin
+ */
 export interface ParagraphToolCSS {
   /**
    * Block CSS class name

diff --git a/vite.config.ts b/vite.config.ts
@@ -19,7 +19,7 @@ export default defineConfig({
     build: {
         lib: {
             entry: path.resolve(__dirname, 'src', 'index.ts'),
-            name: 'paragraph',
+            name: 'Paragraph',
             formats: ['umd', 'es'],
             fileName: 'paragraph',
         },