@dotcms/react 0.0.1-alpha.2 → 0.0.1-alpha.4

package/README.md

@@ -4,9 +4,9 @@
 
 ## Features
 
-- A collection of React components and hooks tailored to render dotCMS pages.
-- Streamlined integration with dotCMS page editor.
-- Improved development experience with comprehensive TypeScript typings.
+-   A collection of React components and hooks tailored to render dotCMS pages.
+-   Streamlined integration with dotCMS page editor.
+-   Improved development experience with comprehensive TypeScript typings.
 
 ## Installation
 
@@ -30,7 +30,7 @@ A functional component that renders a layout for a dotCMS page.
 
 #### Props
 
-- **entity**: The context for a dotCMS page.
+-   **entity**: The context for a dotCMS page.
 
 #### Usage
 
@@ -38,7 +38,7 @@ A functional component that renders a layout for a dotCMS page.
 import { DotcmsLayout } from '@dotcms/react';
 
 const MyPage = ({ entity }) => {
-  return <DotcmsLayout entity={entity} />;
+    return <DotcmsLayout entity={entity} />;
 };
 ```
 
@@ -50,7 +50,7 @@ A custom React hook that provides access to the `PageProviderContext`.
 
 #### Returns
 
-- `PageProviderContext | null`: The context value or `null` if it's not available.
+-   `PageProviderContext | null`: The context value or `null` if it's not available.
 
 #### Usage
 
@@ -58,8 +58,8 @@ A custom React hook that provides access to the `PageProviderContext`.
 import { useDotcmsPageContext } from '@dotcms/react';
 
 const MyComponent = () => {
-  const context = useDotcmsPageContext();
-  // Use the context
+    const context = useDotcmsPageContext();
+    // Use the context
 };
 ```
 
@@ -69,11 +69,11 @@ A custom React hook that sets up the page editor for a dotCMS page.
 
 #### Parameters
 
-- **props**: `PageEditorOptions` - The options for the page editor. Includes a `reloadFunction` and a `pathname`.
+-   **props**: `PageEditorOptions` - The options for the page editor. Includes a `reloadFunction` and a `pathname`.
 
 #### Returns
 
-- `React.RefObject<HTMLDivElement>[]`: A reference to the rows of the page.
+-   `React.RefObject<HTMLDivElement>[]`: A reference to the rows of the page.
 
 #### Usage
 
@@ -81,8 +81,8 @@ A custom React hook that sets up the page editor for a dotCMS page.
 import { usePageEditor } from '@dotcms/react';
 
 const MyEditor = () => {
-  const rowsRef = usePageEditor({ pathname: '/my-page' });
-  // Use the rowsRef
+    const rowsRef = usePageEditor({ pathname: '/my-page' });
+    // Use the rowsRef
 };
 ```
 
@@ -94,8 +94,8 @@ A functional component that provides a context for a dotCMS page.
 
 #### Props
 
-- **entity**: The entity representing the page's data.
-- **children**: The children components.
+-   **entity**: The entity representing the page's data.
+-   **children**: The children components.
 
 #### Usage
 
@@ -103,11 +103,7 @@ A functional component that provides a context for a dotCMS page.
 import { PageProvider } from '@dotcms/react';
 
 const MyApp = ({ entity }) => {
-  return (
-    <PageProvider entity={entity}>
-      {/* children */}
-    </PageProvider>
-  );
+    return <PageProvider entity={entity}>{/* children */}</PageProvider>;
 };
 ```
 
@@ -115,7 +111,6 @@ const MyApp = ({ entity }) => {
 
 GitHub pull requests are the preferred method to contribute code to dotCMS. Before any pull requests can be accepted, an automated tool will ask you to agree to the [dotCMS Contributor's Agreement](https://gist.github.com/wezell/85ef45298c48494b90d92755b583acb3).
 
-
 ## Licensing
 
 dotCMS comes in multiple editions and as such is dual licensed. The dotCMS Community Edition is licensed under the GPL 3.0 and is freely available for download, customization and deployment for use within organizations of all stripes. dotCMS Enterprise Editions (EE) adds a number of enterprise features and is available via a supported, indemnified commercial license from dotCMS. For the differences between the editions, see [the feature page](http://dotcms.com/cms-platform/features).
@@ -138,4 +133,4 @@ Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/
 | Code Examples   | [Codeshare](https://dotcms.com/codeshare/)                          |
 | Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
 | Twitter         | @dotCMS                                                             |
-| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |