@excalidraw/excalidraw 0.11.0-5346-59101a1 → 0.11.0-5346-d3655cd

package/README.md

@@ -1,39 +1,41 @@
-<!-- unstable-readme-start-->
+#### Note
 
-## Note
-
-**This is an unstable release and not recommended for production. If you don't want to wait for the stable release and try out the unreleased changes you can use this.**
-
-For stable release please use [@excalidraw/excalidraw](https://www.npmjs.com/package/@excalidraw/excalidraw).
-
-<!-- unstable-readme-end-->
+⚠️ ⚠️ ⚠️ You are viewing the docs for the **next** release, in case you want to check the docs for the stable release, you can view it [here](https://www.npmjs.com/package/@excalidraw/excalidraw).
 
 ### Excalidraw
 
 Excalidraw exported as a component to directly embed in your projects.
 
+#### Note
+
+⚠️ ⚠️ ⚠️ You are viewing the docs for the **next** release, in case you want to check the docs for the stable release, you can view it [here](https://www.npmjs.com/package/@excalidraw/excalidraw).
+
 ### Installation
 
 You can use npm
 
 ```
-npm install react react-dom @excalidraw/excalidraw-next
+npm install react react-dom @excalidraw/excalidraw
 ```
 
 or via yarn
 
 ```
-yarn add react react-dom @excalidraw/excalidraw-next
+yarn add react react-dom @excalidraw/excalidraw
 ```
 
 After installation you will see a folder `excalidraw-assets` and `excalidraw-assets-dev` in `dist` directory which contains the assets needed for this app in prod and dev mode respectively.
 
 Move the folder `excalidraw-assets` and `excalidraw-assets-dev` to the path where your assets are served.
 
-By default it will try to load the files from `https://unpkg.com/@excalidraw/excalidraw-next/dist/`
+By default it will try to load the files from `https://unpkg.com/@excalidraw/excalidraw/dist/`
 
 If you want to load assets from a different path you can set a variable `window.EXCALIDRAW_ASSET_PATH` depending on environment (for example if you have different URL's for dev and prod) to the url from where you want to load the assets.
 
+#### Note
+
+**If you don't want to wait for the next stable release and try out the unreleased changes you can use `@excalidraw/excalidraw@next`.**
+
 ### Demo
 
 [Try here](https://codesandbox.io/s/excalidraw-ehlz3).
@@ -48,7 +50,7 @@ If you are using a Web bundler (for instance, Webpack), you can import it as an
 
 ```js
 import React, { useEffect, useState, useRef } from "react";
-import { Excalidraw } from "@excalidraw/excalidraw-next";
+import { Excalidraw } from "@excalidraw/excalidraw";
 import InitialData from "./initialData";
 
 import "./styles.scss";
@@ -166,13 +168,13 @@ import { useState, useEffect } from "react";
 export default function IndexPage() {
   const [Comp, setComp] = useState(null);
   useEffect(() => {
-    import("@excalidraw/excalidraw-next").then((comp) => setComp(comp.default));
+    import("@excalidraw/excalidraw").then((comp) => setComp(comp.default));
   }, []);
   return <>{Comp && <Comp />}</>;
 }
 ```
 
-The `types` are available at `@excalidraw/excalidraw-next/types`, you can view [example for typescript](https://codesandbox.io/s/excalidraw-types-9h2dm)
+The `types` are available at `@excalidraw/excalidraw/types`, you can view [example for typescript](https://codesandbox.io/s/excalidraw-types-9h2dm)
 
 #### In Browser
 
@@ -183,7 +185,7 @@ For development use :point_down:
 ```js
 <script
   type="text/javascript"
-  src="https://unpkg.com/@excalidraw/excalidraw-next/dist/excalidraw.development.js"
+  src="https://unpkg.com/@excalidraw/excalidraw/dist/excalidraw.development.js"
 ></script>
 ```
 
@@ -192,7 +194,7 @@ For production use :point_down:
 ```js
 <script
   type="text/javascript"
-  src="https://unpkg.com/@excalidraw/excalidraw-next/dist/excalidraw.production.min.js"
+  src="https://unpkg.com/@excalidraw/excalidraw/dist/excalidraw.production.min.js"
 ></script>
 ```
 
@@ -211,7 +213,7 @@ You will need to make sure `react`, `react-dom` is available as shown in the bel
 
     <script
       type="text/javascript"
-      src="https://unpkg.com/@excalidraw/excalidraw-next/dist/excalidraw.development.js"
+      src="https://unpkg.com/@excalidraw/excalidraw/dist/excalidraw.development.js"
     ></script>
   </head>
 
@@ -585,7 +587,7 @@ This callback is triggered when mouse pointer is updated.
 Determines the language of the UI. It should be one of the [available language codes](https://github.com/excalidraw/excalidraw/blob/master/src/i18n.ts#L14). Defaults to `en` (English). We also export default language and supported languages which you can import as shown below.
 
 ```js
-import { defaultLang, languages } from "@excalidraw/excalidraw-next";
+import { defaultLang, languages } from "@excalidraw/excalidraw";
 ```
 
 | name | type |
@@ -829,7 +831,7 @@ restoreAppState(appState: <a href="https://github.com/excalidraw/excalidraw/blob
 **_How to use_**
 
 ```js
-import { restoreAppState } from "@excalidraw/excalidraw-next";
+import { restoreAppState } from "@excalidraw/excalidraw";
 ```
 
 This function will make sure all the keys have appropriate values in [appState](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L79) and if any key is missing, it will be set to default value.
@@ -847,7 +849,7 @@ restoreElements(elements: <a href="https://github.com/excalidraw/excalidraw/blob
 **_How to use_**
 
 ```js
-import { restoreElements } from "@excalidraw/excalidraw-next";
+import { restoreElements } from "@excalidraw/excalidraw";
 ```
 
 This function will make sure all properties of element is correctly set and if any attribute is missing, it will be set to default value.
@@ -867,7 +869,7 @@ See [`restoreAppState()`](https://github.com/excalidraw/excalidraw/blob/master/s
 **_How to use_**
 
 ```js
-import { restore } from "@excalidraw/excalidraw-next";
+import { restore } from "@excalidraw/excalidraw";
 ```
 
 This function makes sure elements and state is set to appropriate values and set to default value if not present. It is a combination of [restoreElements](#restoreElements) and [restoreAppState](#restoreAppState).
@@ -883,7 +885,7 @@ restoreLibraryItems(libraryItems: <a href="https://github.com/excalidraw/excalid
 **_How to use_**
 
 ```js
-import { restoreLibraryItems } from "@excalidraw/excalidraw-next";
+import { restoreLibraryItems } from "@excalidraw/excalidraw";
 
 restoreLibraryItems(libraryItems, "unpublished");
 ```
@@ -916,7 +918,7 @@ This function normalizes library items elements, adding missing values when need
 **How to use**
 
 ```js
-import { exportToCanvas } from "@excalidraw/excalidraw-next";
+import { exportToCanvas } from "@excalidraw/excalidraw";
 ```
 
 This function returns the canvas with the exported elements, appState and dimensions.
@@ -942,7 +944,7 @@ exportToBlob(
 **How to use**
 
 ```js
-import { exportToBlob } from "@excalidraw/excalidraw-next";
+import { exportToBlob } from "@excalidraw/excalidraw";
 ```
 
 Returns a promise which resolves with a [blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob). It internally uses [canvas.ToBlob](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/toBlob).
@@ -993,7 +995,7 @@ exportToClipboard(
 **How to use**
 
 ```js
-import { exportToClipboard } from "@excalidraw/excalidraw-next";
+import { exportToClipboard } from "@excalidraw/excalidraw";
 ```
 
 Copies the scene data in the specified format (determined by `type`) to clipboard.
@@ -1042,7 +1044,7 @@ If you want to overwrite the source field in the JSON string, you can set `windo
 **How to use**
 
 <pre>
-import { getSceneVersion } from "@excalidraw/excalidraw-next";
+import { getSceneVersion } from "@excalidraw/excalidraw";
 getSceneVersion(elements:  <a href="https://github.com/excalidraw/excalidraw/blob/master/src/element/types.ts#L106">ExcalidrawElement[]</a>)
 </pre>
 
@@ -1059,7 +1061,7 @@ isInvisiblySmallElement(element:  <a href="https://github.com/excalidraw/excalid
 **How to use**
 
 ```js
-import { isInvisiblySmallElement } from "@excalidraw/excalidraw-next";
+import { isInvisiblySmallElement } from "@excalidraw/excalidraw";
 ```
 
 Returns `true` if element is invisibly small (e.g. width & height are zero).
@@ -1067,7 +1069,7 @@ Returns `true` if element is invisibly small (e.g. width & height are zero).
 #### `loadLibraryFromBlob`
 
 ```js
-import { loadLibraryFromBlob } from "@excalidraw/excalidraw-next";
+import { loadLibraryFromBlob } from "@excalidraw/excalidraw";
 ```
 
 **_Signature_**
@@ -1083,7 +1085,7 @@ This function loads the library from the blob.
 **How to use**
 
 ```js
-import { loadFromBlob } from "@excalidraw/excalidraw-next";
+import { loadFromBlob } from "@excalidraw/excalidraw";
 
 const scene = await loadFromBlob(file, null, null);
 excalidrawAPI.updateScene(scene);
@@ -1135,7 +1137,7 @@ This function loads either scene or library data from the supplied blob. If the
 **How to use**
 
 ```js
-import { getFreeDrawSvgPath } from "@excalidraw/excalidraw-next";
+import { getFreeDrawSvgPath } from "@excalidraw/excalidraw";
 ```
 
 **Signature**
@@ -1151,7 +1153,7 @@ This function returns the free draw svg path for the element.
 **How to use**
 
 ```js
-import { isLinearElement } from "@excalidraw/excalidraw-next";
+import { isLinearElement } from "@excalidraw/excalidraw";
 ```
 
 **Signature**
@@ -1167,7 +1169,7 @@ This function returns true if the element is linear type (`arrow` |`line`) else
 **How to use**
 
 ```js
-import { getNonDeletedElements } from "@excalidraw/excalidraw-next";
+import { getNonDeletedElements } from "@excalidraw/excalidraw";
 ```
 
 **Signature**
@@ -1181,7 +1183,7 @@ This function returns an array of deleted elements.
 #### `mergeLibraryItems`
 
 ```js
-import { mergeLibraryItems } from "@excalidraw/excalidraw-next";
+import { mergeLibraryItems } from "@excalidraw/excalidraw";
 ```
 
 **_Signature_**
@@ -1197,7 +1199,7 @@ This function merges two `LibraryItems` arrays, where unique items from `otherIt
 **How to use**
 
 ```js
-import { parseLibraryTokensFromUrl } from "@excalidraw/excalidraw-next";
+import { parseLibraryTokensFromUrl } from "@excalidraw/excalidraw";
 ```
 
 **Signature**
@@ -1216,7 +1218,7 @@ Parses library parameters from URL if present (expects the `#addLibrary` hash ke
 **How to use**
 
 ```js
-import { useHandleLibrary } from "@excalidraw/excalidraw-next";
+import { useHandleLibrary } from "@excalidraw/excalidraw";
 
 export const App = () => {
   // ...
@@ -1240,7 +1242,7 @@ In the future, we will be adding support for handling library persistence to bro
 #### `sceneCoordsToViewportCoords`
 
 ```js
-import { sceneCoordsToViewportCoords } from "@excalidraw/excalidraw-next";
+import { sceneCoordsToViewportCoords } from "@excalidraw/excalidraw";
 ```
 
 **_Signature_**
@@ -1254,7 +1256,7 @@ This function returns equivalent viewport coords for the provided scene coords i
 #### `viewportCoordsToSceneCoords`
 
 ```js
-import { viewportCoordsToSceneCoords } from "@excalidraw/excalidraw-next";
+import { viewportCoordsToSceneCoords } from "@excalidraw/excalidraw";
 ```
 
 **_Signature_**
@@ -1272,7 +1274,7 @@ This function returns equivalent scene coords for the provided viewport coords i
 **How to use**
 
 ```js
-import { FONT_FAMILY } from "@excalidraw/excalidraw-next";
+import { FONT_FAMILY } from "@excalidraw/excalidraw";
 ```
 
 `FONT_FAMILY` contains all the font families used in `Excalidraw` as explained below
@@ -1290,7 +1292,7 @@ Defaults to `FONT_FAMILY.Virgil` unless passed in `initialData.appState.currentI
 **How to use**
 
 ```js
-import { THEME } from "@excalidraw/excalidraw-next";
+import { THEME } from "@excalidraw/excalidraw";
 ```
 
 `THEME` contains all the themes supported by `Excalidraw` as explained below
@@ -1307,7 +1309,7 @@ Defaults to `THEME.LIGHT` unless passed in `initialData.appState.theme`
 **How to use **
 
 ```js
-import { MIME_TYPES } from "@excalidraw/excalidraw-next";
+import { MIME_TYPES } from "@excalidraw/excalidraw";
 ```
 
 [`MIME_TYPES`](https://github.com/excalidraw/excalidraw/blob/master/src/constants.ts#L92) contains all the mime types supported by `Excalidraw`.
@@ -1342,4 +1344,4 @@ You can create a test release by posting the below comment in your pull request
 @excalibot release package
 ```
 
-Once the version is released `@excalibot` will post a comment with the release version.
+Once the version is released `@excalibot` will post a comment with the release version.