ct-rich-text-editor 1.1.4 → 1.1.6

package/README.md

@@ -1,147 +1,147 @@
-# CT Rich Text Editor
-
-A configurable rich text editor component with API key authentication.
-
-## Installation
-
-```bash
-npm install ct-rich-text-editor
-# or
-yarn add ct-rich-text-editor
-```
-
-## Features
-
-- Rich text editor with extensive formatting options
-- API key authentication
-- Configurable UI components (toolbar, floating menu)
-- HTML view option
-- Support for tables, images, links, and more
-- AI chat integration (for premium plans)
-- Environment-based API configuration
-
-## Usage
-
-### Important: Importing Styles
-To ensure proper styling of the editor components including tables, you must import the package's CSS:
-
-```jsx
-// Import the styles in your application
-import 'ct-rich-text-editor/style.css';
-```
-
-### Basic Setup
-
-```jsx
-import React from 'react';
-import { 
-  ConfigurableEditorWithAuth, 
-  EditorProvider,
-  defaultEditorConfig
-} from 'ct-rich-text-editor';
-// Import required styles
-import 'ct-rich-text-editor/style.css';
-
-function App() {
-  const apiKey = 'your-api-key'; // Replace with your actual API key
-  
-  return (
-    <EditorProvider
-      defaultFontFamilies={defaultEditorConfig.defaultFontFamilies}
-      mentionUserList={defaultEditorConfig.mentionUserList}
-    >
-      <ConfigurableEditorWithAuth
-        apiKey={apiKey}
-        onAuthSuccess={() => console.log('Authentication successful')}
-        onAuthError={(error) => console.error('Authentication error:', error)}
-      />
-    </EditorProvider>
-  );
-}
-```
-
-## API Reference
-
-### EditorProvider
-
-Provides authentication and configuration context for the editor.
-
-#### Props
-
-- `children`: React nodes to render
-- `defaultFontFamilies`: Array of font names (optional)
-- `mentionUserList`: Array of usernames for mention functionality (optional)
-
-### ConfigurableEditorWithAuth
-
-The main editor component with authentication.
-
-#### Props
-
-- `apiKey`: Your API key for authentication (required)
-- `onAuthSuccess`: Callback function when authentication is successful (optional)
-- `onAuthError`: Callback function when authentication fails (optional)
-- `showToolbar`: Boolean to show/hide the toolbar (optional, default: true)
-- `showFloatingMenu`: Boolean to show/hide the floating menu (optional, default: true)
-- `showHtmlView`: Boolean to show/hide HTML view option (optional, default: true)
-- `initialContent`: Initial content for the editor (optional)
-- `onChange`: Callback function when editor content changes (optional)
-- `readOnly`: Boolean to make editor read-only (optional, default: false)
-- `placeholder`: Placeholder text when editor is empty (optional)
-- `theme`: Custom theme object for styling (optional)
-- `plugins`: Array of custom plugins (optional)
-- `aiEnabled`: Boolean to enable/disable AI features (optional, default: false)
-- `onAiResponse`: Callback function for AI responses (optional)
-- `onAiError`: Callback function for AI errors (optional)
-
-## Examples
-
-### Basic Editor with Authentication
-
-```jsx
-import React from 'react';
-import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
-import 'ct-rich-text-editor/style.css';
-
-function App() {
-  return (
-    <EditorProvider>
-      <ConfigurableEditorWithAuth
-        apiKey="your-api-key"
-        onAuthSuccess={() => console.log('Authenticated')}
-        onAuthError={(error) => console.error(error)}
-      />
-    </EditorProvider>
-  );
-}
-```
-
-### Editor with Custom Configuration
-
-```jsx
-import React from 'react';
-import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
-import 'ct-rich-text-editor/style.css';
-
-function App() {
-  return (
-    <EditorProvider>
-      <ConfigurableEditorWithAuth
-        apiKey="your-api-key"
-        showToolbar={true}
-        showFloatingMenu={true}
-        showHtmlView={true}
-        readOnly={false}
-        placeholder="Start typing..."
-        aiEnabled={true}
-        onAiResponse={(response) => console.log('AI Response:', response)}
-        onAiError={(error) => console.error('AI Error:', error)}
-      />
-    </EditorProvider>
-  );
-}
-```
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details.
+# CT Rich Text Editor
+
+A configurable rich text editor component with API key authentication.
+
+## Installation
+
+```bash
+npm install ct-rich-text-editor
+# or
+yarn add ct-rich-text-editor
+```
+
+## Features
+
+- Rich text editor with extensive formatting options
+- API key authentication
+- Configurable UI components (toolbar, floating menu)
+- HTML view option
+- Support for tables, images, links, and more
+- AI chat integration (for premium plans)
+- Environment-based API configuration
+
+## Usage
+
+### Important: Importing Styles
+To ensure proper styling of the editor components including tables, you must import the package's CSS:
+
+```jsx
+// Import the styles in your application
+import 'ct-rich-text-editor/style.css';
+```
+
+### Basic Setup
+
+```jsx
+import React from 'react';
+import { 
+  ConfigurableEditorWithAuth, 
+  EditorProvider,
+  defaultEditorConfig
+} from 'ct-rich-text-editor';
+// Import required styles
+import 'ct-rich-text-editor/style.css';
+
+function App() {
+  const apiKey = 'your-api-key'; // Replace with your actual API key
+  
+  return (
+    <EditorProvider
+      defaultFontFamilies={defaultEditorConfig.defaultFontFamilies}
+      mentionUserList={defaultEditorConfig.mentionUserList}
+    >
+      <ConfigurableEditorWithAuth
+        apiKey={apiKey}
+        onAuthSuccess={() => console.log('Authentication successful')}
+        onAuthError={(error) => console.error('Authentication error:', error)}
+      />
+    </EditorProvider>
+  );
+}
+```
+
+## API Reference
+
+### EditorProvider
+
+Provides authentication and configuration context for the editor.
+
+#### Props
+
+- `children`: React nodes to render
+- `defaultFontFamilies`: Array of font names (optional)
+- `mentionUserList`: Array of usernames for mention functionality (optional)
+
+### ConfigurableEditorWithAuth
+
+The main editor component with authentication.
+
+#### Props
+
+- `apiKey`: Your API key for authentication (required)
+- `onAuthSuccess`: Callback function when authentication is successful (optional)
+- `onAuthError`: Callback function when authentication fails (optional)
+- `showToolbar`: Boolean to show/hide the toolbar (optional, default: true)
+- `showFloatingMenu`: Boolean to show/hide the floating menu (optional, default: true)
+- `showHtmlView`: Boolean to show/hide HTML view option (optional, default: true)
+- `initialContent`: Initial content for the editor (optional)
+- `onChange`: Callback function when editor content changes (optional)
+- `readOnly`: Boolean to make editor read-only (optional, default: false)
+- `placeholder`: Placeholder text when editor is empty (optional)
+- `theme`: Custom theme object for styling (optional)
+- `plugins`: Array of custom plugins (optional)
+- `aiEnabled`: Boolean to enable/disable AI features (optional, default: false)
+- `onAiResponse`: Callback function for AI responses (optional)
+- `onAiError`: Callback function for AI errors (optional)
+
+## Examples
+
+### Basic Editor with Authentication
+
+```jsx
+import React from 'react';
+import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
+import 'ct-rich-text-editor/style.css';
+
+function App() {
+  return (
+    <EditorProvider>
+      <ConfigurableEditorWithAuth
+        apiKey="your-api-key"
+        onAuthSuccess={() => console.log('Authenticated')}
+        onAuthError={(error) => console.error(error)}
+      />
+    </EditorProvider>
+  );
+}
+```
+
+### Editor with Custom Configuration
+
+```jsx
+import React from 'react';
+import { ConfigurableEditorWithAuth, EditorProvider } from 'ct-rich-text-editor';
+import 'ct-rich-text-editor/style.css';
+
+function App() {
+  return (
+    <EditorProvider>
+      <ConfigurableEditorWithAuth
+        apiKey="your-api-key"
+        showToolbar={true}
+        showFloatingMenu={true}
+        showHtmlView={true}
+        readOnly={false}
+        placeholder="Start typing..."
+        aiEnabled={true}
+        onAiResponse={(response) => console.log('AI Response:', response)}
+        onAiError={(error) => console.error('AI Error:', error)}
+      />
+    </EditorProvider>
+  );
+}
+```
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.