-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Added links to API docs for respective packages (#5719)
Signed-off-by: Vladlen Fedosov <[email protected]> Co-authored-by: Vladlen Fedosov <[email protected]>
- Loading branch information
Showing
39 changed files
with
61 additions
and
111 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/clipboard` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_clipboard) | ||
|
||
This package contains the functionality for the clipboard feature of Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/code` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_code) | ||
|
||
This package contains the functionality for the code blocks and code highlighting for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# `@lexical/dragon` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_dragon) | ||
|
||
This package contains compatibility with Dragon NaturallySpeaking accessibility tools. | ||
|
||
More documentation coming soon. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/file` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_file) | ||
|
||
This package contains the functionality for the file import/export feature of Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# `@lexical/hashtag` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_hashtag) | ||
|
||
This package contains the functionality for Lexical hashtags. | ||
|
||
More documentation coming soon. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# `@lexical/link` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_link) | ||
|
||
This package contains the functionality for Lexical links. | ||
|
||
More documentation coming soon. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/mark` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_mark) | ||
|
||
This package contains helpers and nodes for wrapping content in marks for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/offset` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_offset) | ||
|
||
This package contains selection offset helpers for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/overflow` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_overflow) | ||
|
||
This package contains selection overflow helpers and nodes for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,112 +1,5 @@ | ||
# `@lexical/selection` | ||
|
||
This package contains selection helpers for Lexical. | ||
|
||
### Methods | ||
|
||
#### `getStyleObjectFromCSS` | ||
|
||
Given a CSS string, returns an object from the style cache. | ||
|
||
```ts | ||
export function getStyleObjectFromCSS(css: string): { | ||
[key: string]: string; | ||
} | null; | ||
``` | ||
|
||
#### `$patchStyleText` | ||
|
||
Applies the provided styles to the TextNodes in the provided Selection. Key names in the patch argument should be | ||
the valid CSS properties (i.e., kebab-case). | ||
|
||
```ts | ||
export function $patchStyleText( | ||
selection: BaseSelection, | ||
patch: { | ||
[key: string]: string; | ||
}, | ||
): void; | ||
``` | ||
|
||
#### `$getSelectionStyleValueForProperty` | ||
|
||
Given a selection and a valid CSS property name, returns the current value of that property for TextNodes in the Selection, if set. If not set, it returns the defaultValue. If all TextNodes do not have the same value, it returns an empty string. | ||
|
||
```ts | ||
export function $getSelectionStyleValueForProperty( | ||
selection: RangeSelection, | ||
styleProperty: string, | ||
defaultValue: string, | ||
): string; | ||
``` | ||
|
||
#### `$moveCaretSelection` | ||
|
||
Moves the selection according to the arguments. | ||
|
||
```ts | ||
export function $moveCaretSelection( | ||
selection: RangeSelection, | ||
isHoldingShift: boolean, | ||
isBackward: boolean, | ||
granularity: 'character' | 'word' | 'lineboundary', | ||
): void; | ||
``` | ||
|
||
#### `$isParentElementRTL` | ||
|
||
Returns true if the parent of the Selection anchor node is in Right-To-Left mode, false if not. | ||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_selection) | ||
|
||
```ts | ||
export function $isParentElementRTL(selection: RangeSelection): boolean; | ||
``` | ||
|
||
#### `$moveCharacter` | ||
|
||
Wraps $moveCaretSelection, using character granularity and accounting for RTL mode. | ||
|
||
```ts | ||
export function $moveCharacter( | ||
selection: RangeSelection, | ||
isHoldingShift: boolean, | ||
isBackward: boolean, | ||
): void; | ||
``` | ||
|
||
#### `$selectAll` | ||
|
||
Expands the current Selection to cover all of the content in the editor. | ||
|
||
```ts | ||
export function $selectAll(selection: RangeSelection): void; | ||
``` | ||
|
||
#### `$setBlocksType` | ||
|
||
Converts all nodes in the selection that are of one block type to another specified by parameter | ||
|
||
```ts | ||
export function $setBlocksType( | ||
selection: RangeSelection, | ||
createElement: () => ElementNode, | ||
): void; | ||
``` | ||
|
||
#### `$isAtNodeEnd` | ||
|
||
Returns true if the provided point offset is in the last possible position. | ||
|
||
```ts | ||
export function $isAtNodeEnd(point: Point): boolean; | ||
``` | ||
|
||
#### `$shouldOverrideDefaultCharacterSelection` | ||
|
||
Returns true if default character selection should be overridden, false if not. Used with DecoratorNodes | ||
|
||
```ts | ||
export function $shouldOverrideDefaultCharacterSelection( | ||
selection: RangeSelection, | ||
isBackward: boolean, | ||
): boolean; | ||
``` | ||
This package contains selection helpers for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# `@lexical/table` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_table) | ||
|
||
This package contains the functionality for the Tables feature of Lexical. | ||
|
||
More documentation coming soon. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/text` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_text) | ||
|
||
This package contains utilities and helpers for handling Lexical text. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,5 @@ | ||
# `@lexical/utils` | ||
|
||
[![See API Documentation](https://lexical.dev/img/see-api-documentation.svg)](https://lexical.dev/docs/api/modules/lexical_utils) | ||
|
||
This package contains misc utilities for Lexical. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.