https://lexical.dev/assets/js/30a4a96d.059e152a.js

1"use strict";(self.webpackChunk_lexical_website=self.webpackChunk_lexical_website||[]).push([["6830"],{9657(e,d,i){i.r(d),i.d(d,{metadata:()=>n,default:()=>h,frontMatter:()=>s,contentTitle:()=>c,toc:()=>t,assets:()=>r});var n=JSON.parse('{"id":"api/modules/lexical_code-core","title":"@lexical/code-core","description":"Variables","source":"@site/docs/api/modules/lexical_code-core.md","sourceDirName":"api/modules","slug":"/api/modules/lexical_code-core","permalink":"/docs/api/modules/lexical_code-core","draft":false,"unlisted":false,"editUrl":"https://github.com/facebook/lexical/tree/main/packages/lexical-website/docs/api/modules/lexical_code-core.md","tags":[],"version":"current","frontMatter":{},"sidebar":"api","previous":{"title":"@lexical/clipboard","permalink":"/docs/api/modules/lexical_clipboard"},"next":{"title":"@lexical/code-prism","permalink":"/docs/api/modules/lexical_code-prism"}}'),o=i(41627),l=i(86958);let s={},c="@lexical/code-core",r={},t=[{value:"Variables",id:"variables",level:2},{value:"<del>CodeImportExtension</del>",id:"codeimportextension",level:3},{value:"Deprecated",id:"deprecated",level:4},{value:"CodeImportRules",id:"codeimportrules",level:3},{value:"Functions",id:"functions",level:2},{value:"$plainifyCodeContent()",id:"plainifycodecontent",level:3},{value:"Parameters",id:"parameters",level:4},{value:"text",id:"text",level:5},{value:"Returns",id:"returns",level:4},{value:"References",id:"references",level:2},{value:"$createCodeHighlightNode",id:"createcodehighlightnode",level:3},{value:"$createCodeNode",id:"createcodenode",level:3},{value:"$getCodeLineDirection",id:"getcodelinedirection",level:3},{value:"$getEndOfCodeInLine",id:"getendofcodeinline",level:3},{value:"$getFirstCodeNodeOfLine",id:"getfirstcodenodeofline",level:3},{value:"$getLastCodeNodeOfLine",id:"getlastcodenodeofline",level:3},{value:"$getStartOfCodeInLine",id:"getstartofcodeinline",level:3},{value:"$isCodeHighlightNode",id:"iscodehighlightnode",level:3},{value:"$isCodeNode",id:"iscodenode",level:3},{value:"$outdentLeadingSpaces",id:"outdentleadingspaces",level:3},{value:"CodeExtension",id:"codeextension",level:3}

1,{value:"CodeHighlightNode",id:"codehighlightnode",level:3},{value:"CodeIndentConfig",id:"codeindentconfig",level:3},{value:"CodeIndentExtension",id:"codeindentextension",level:3},{value:"CodeNode",id:"codenode",level:3},{value:"DEFAULT_CODE_LANGUAGE",id:"default_code_language",level:3},{value:"SerializedCodeNode",id:"serializedcodenode",level:3}];function a(e){let d={a:"a",blockquote:"blockquote",code:"code",del:"del",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",p:"p",strong:"strong",...(0,l.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(d.header,{children:(0,o.jsx)(d.h1,{id:"lexicalcode-core",children:"@lexical/code-core"})}),"\n",(0,o.jsx)(d.h2,{id:"variables",children:"Variables"}),"\n",(0,o.jsx)(d.h3,{id:"codeimportextension",children:(0,o.jsx)(d.del,{children:"CodeImportExtension"})}),"\n",(0,o.jsxs)(d.blockquote,{children:["\n",(0,o.jsxs)(d.p,{children:[(0,o.jsx)(d.code,{children:"const"})," ",(0,o.jsx)(d.strong,{children:"CodeImportExtension"}),": ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical#lexicalextension",children:(0,o.jsx)(d.code,{children:"LexicalExtension"})}),"<",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical#extensionconfigbase",children:(0,o.jsx)(d.code,{children:"ExtensionConfigBase"})}),", ",(0,o.jsx)(d.code,{children:'"@lexical/code/Import"'}),", ",(0,o.jsx)(d.code,{children:"unknown"}),", ",(0,o.jsx)(d.code,{children:"unknown"}),">"]}),"\n"]}),"\n",(0,o.jsxs)(d.p,{children:["Defined in: ",(0,o.jsx)(d.a,{href:"https://github.com/facebook/lexical/tree/main/packages/lexical-code-core/src/CodeExtension.ts#L78",children:"packages/lexical-code-core/src/CodeExtension.ts:78"})]}),"\n",(0,o.jsx)(d.p,{children:(0,o.jsx)(d.strong,{children:(0,o.jsx)(d.code,{children:"Experimental"})})}),"\n",(0,o.jsxs)(d.p,{children:["Bundles ",(0,o.jsx)(d.a,{href:"#codeimportrules",children:"CodeImportRules"})," together with the runtime\n",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeextension",children:"CodeExtension"}),"."]}),"\n",(0,o.jsx)(d.h4,{id:"deprecated",children:"Deprecated"}),"\n",(0,o.jsxs)(d.p,{children:[(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeextension",children:"CodeExtension"})," now registers\n",(0,o.jsx)(d.a,{href:"#codeimportrules",children:"CodeImportRules"})," (and ",(0,o.jsx)(d.code,{children:"CoreImportExtension"}),") itself \u2014 depend on\nit directly instead."]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codeimportrules",children:"CodeImportRules"}),"\n",(0,o.jsxs)(d.blockquote,{children:["\n",(0,o.jsxs)(d.p,{children:[(0,o.jsx)(d.code,{children:"const"})," ",(0,o.jsx)(d.strong,{children:"CodeImportRules"}),": ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_html#domimportrule",children:(0,o.jsx)(d.code,{children:"DOMImportRule"})}),"<",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_html#elementselectorbuilder",children:(0,o.jsx)(d.code,{children:"ElementSelectorBuilder"})}),"<",(0,o.jsx)(d.a,{href:"https://developer.mozilla.org/docs/Web/API/HTMLElement",children:(0,o.jsx)(d.code,{children:"HTMLElement"})}),", ",(0,o.jsx)(d.a,{href:"https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",children:(0,o.jsx)(d.code,{children:"Record"})}),"<",(0,o.jsx)(d.code,{children:"string"}),", ",(0,o.jsx)(d.code,{children:"never"}),">>>[]"]}),"\n"]}),"\n",(0,o.jsxs)(d.p,{children:["Defined in: ",(0,o.jsx)(d.a,{href:"https://github.com/facebook/lexical/tree/main/packages/lexical-code-core/src/CodeImportExtension.ts#L375",children:"packages/lexical-code-core/src/CodeImportExtension.ts:375"})]}),"\n",(0,o.jsx)(d.p,{children:(0,o.jsx)(d.strong,{children:(0,o.jsx)(d.code,{children:"Experimental"})})}),"\n",(0,o.jsxs)(d.p,{children:["Import rules for ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codenode",children:"CodeNode"}),"."]}),"\n",(0,o.jsxs)(d.p,{children:["Specific class-restricted rules (GitHub raw-file-view detectors) are\nregistered before the generic ",(0,o.jsx)(d.code,{children:"<table>"})," / ",(0,o.jsx)(d.code,{children:"<tr>"})," / ",(0,o.jsx)(d.code,{children:"<td>"})," rules so\nthey win dispatch."]}),"\n",(0,o.jsxs)(d.p,{children:["Registered by ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeextension",children:"CodeExtension"})," itself (together with\n",(0,o.jsx)(d.code,{children:"CoreImportExtension"})," and the $installVscodeCodePasteOverlay\npreprocess), so any editor that uses the code extension can import\nthese shapes through the ",(0,o.jsx)(d.code,{children:"DOMImportExtension"})," pipeline without further\nconfiguration."]}),"\n",(0,o.jsx)(d.h2,{id:"functions",children:"Functions"}),"\n",(0,o.jsx)(d.h3,{id:"plainifycodecontent",children:"$plainifyCodeContent()"}),"\n",(0,o.jsxs)(d.blockquote,{children:["\n",(0,o.jsxs)(d.p,{children:[(0,o.jsx)(d.strong,{children:"$plainifyCodeContent"}),"(",(0,o.jsx)(d.code,{children:"text"}),"): ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical#lexicalnode",children:(0,o.jsx)(d.code,{children:"LexicalNode"})}),"[]"]}),"\n"]}),"\n",(0,o.jsxs)(d.p,{children:["Defined in: ",(0,o.jsx)(d.a,{href:"https://github.com/facebook/lexical/tree/main/packages/lexical-code-core/src/FlatStructureUtils.ts#L245",children:"packages/lexical-code-core/src/FlatStructureUtils.ts:245"})]}),"\n",(0,o.jsxs)(d.p,{children:["Plain split of code text into CodeHighlightNodes (with no highlight\ntype) + LineBreakNodes + TabNodes. Used when the tokenizer opts out\nof a default language so a previously highlighted block still\nrenders its ",(0,o.jsx)(d.code,{children:"\\n"})," / ",(0,o.jsx)(d.code,{children:"\\t"})," as real line breaks / tabs, while staying\ncompatible with the indent / shift-lines handlers that only accept\nCodeHighlightNode + TabNode + LineBreakNode inside a CodeNode."]}),"\n",(0,o.jsx)(d.h4,{id:"parameters",children:"Parameters"}),"\n",(0,o.jsx)(d.h5,{id:"text",children:"text"}),"\n",(0,o.jsx)(d.p,{children:(0,o.jsx)(d.code,{children:"string"})}),"\n",(0,o.jsx)(d.h4,{id:"returns",children:"Returns"}),"\n",(0,o.jsxs)(d.p,{children:[(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical#lexicalnode",children:(0,o.jsx)(d.code,{children:"LexicalNode"})}),"[]"]}),"\n",(0,o.jsx)(d.h2,{id:"references",children:"References"}),"\n",(0,o.jsx)(d.h3,{id:"createcodehighlightnode",children:"$createCodeHighlightNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#createcodehighlightnode",children:"$createCodeHighlightNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"createcodenode",children:"$createCodeNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#createcodenode",children:"$createCodeNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"getcodelinedirection",children:"$getCodeLineDirection"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#getcodelinedirection",children:"$getCodeLineDirection"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"getendofcodeinline",children:"$getEndOfCodeInLine"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#getendofcodeinline",children:"$getEndOfCodeInLine"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"getfirstcodenodeofline",children:"$getFirstCodeNodeOfLine"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#getf

1irstcodenodeofline",children:"$getFirstCodeNodeOfLine"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"getlastcodenodeofline",children:"$getLastCodeNodeOfLine"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#getlastcodenodeofline",children:"$getLastCodeNodeOfLine"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"getstartofcodeinline",children:"$getStartOfCodeInLine"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#getstartofcodeinline",children:"$getStartOfCodeInLine"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"iscodehighlightnode",children:"$isCodeHighlightNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#iscodehighlightnode",children:"$isCodeHighlightNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"iscodenode",children:"$isCodeNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#iscodenode",children:"$isCodeNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"outdentleadingspaces",children:"$outdentLeadingSpaces"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#outdentleadingspaces",children:"$outdentLeadingSpaces"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codeextension",children:"CodeExtension"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeextension",children:"CodeExtension"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codehighlightnode",children:"CodeHighlightNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codehighlightnode",children:"CodeHighlightNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codeindentconfig",children:"CodeIndentConfig"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeindentconfig",children:"CodeIndentConfig"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codeindentextension",children:"CodeIndentExtension"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codeindentextension",children:"CodeIndentExtension"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"codenode",children:"CodeNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#codenode",children:"CodeNode"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"default_code_language",children:"DEFAULT_CODE_LANGUAGE"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#default_code_language",children:"DEFAULT_CODE_LANGUAGE"})]}),"\n",(0,o.jsx)(d.hr,{}),"\n",(0,o.jsx)(d.h3,{id:"serializedcodenode",children:"SerializedCodeNode"}),"\n",(0,o.jsxs)(d.p,{children:["Re-exports ",(0,o.jsx)(d.a,{href:"/docs/api/modules/lexical_code#serializedcodenode",children:"SerializedCodeNode"})]})]})}function h(e={}){let{wrapper:d}={...(0,l.R)(),...e.components};return d?(0,o.jsx)(d,{...e,children:(0,o.jsx)(a,{...e})}):a(e)}},86958(e,d,i){i.d(d,{R:()=>s,x:()=>c});var n=i(11979);let o={},l=n.createContext(o);function s(e){let d=n.useContext(l);return n.useMemo(function(){return"function"==typeof e?e(d):{...d,...e}},[d,e])}function c(e){let d;return d=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:s(e.components),n.createElement(l.Provider,{value:d},e.children)}}}]);