1 line
16 KiB
JavaScript
1 line
16 KiB
JavaScript
"use strict";(self.webpackChunkdocs=self.webpackChunkdocs||[]).push([["7302"],{7496:function(e,n,d){d.r(n),d.d(n,{default:()=>a,frontMatter:()=>r,metadata:()=>i,assets:()=>t,toc:()=>o,contentTitle:()=>c});var i=JSON.parse('{"id":"api/internal/interfaces/EditorConfig","title":"Interface: EditorConfig","description":"Extended by","source":"@site/docs/api/internal/interfaces/EditorConfig.md","sourceDirName":"api/internal/interfaces","slug":"/api/internal/interfaces/EditorConfig","permalink":"/docs/api/internal/interfaces/EditorConfig","draft":false,"unlisted":false,"editUrl":"https://github.com/live-codes/livecodes/tree/develop/docs/docs/api/internal/interfaces/EditorConfig.md","tags":[],"version":"current","frontMatter":{}}'),s=d("5893"),l=d("65");let r={},c="Interface: EditorConfig",t={},o=[{value:"Extended by",id:"extended-by",level:2},{value:"Properties",id:"properties",level:2},{value:"closeBrackets",id:"closebrackets",level:3},{value:"Default",id:"default",level:4},{value:"Defined in",id:"defined-in",level:4},{value:"editor",id:"editor",level:3},{value:"Default",id:"default-1",level:4},{value:"Defined in",id:"defined-in-1",level:4},{value:"editorMode",id:"editormode",level:3},{value:"Defined in",id:"defined-in-2",level:4},{value:"editorTheme",id:"editortheme",level:3},{value:"Examples",id:"examples",level:4},{value:"Defined in",id:"defined-in-3",level:4},{value:"emmet",id:"emmet",level:3},{value:"Default",id:"default-2",level:4},{value:"Defined in",id:"defined-in-4",level:4},{value:"enableAI",id:"enableai",level:3},{value:"Default",id:"default-3",level:4},{value:"Defined in",id:"defined-in-5",level:4},{value:"foldRegions",id:"foldregions",level:3},{value:"Default",id:"default-4",level:4},{value:"Defined in",id:"defined-in-6",level:4},{value:"fontFamily",id:"fontfamily",level:3},{value:"Defined in",id:"defined-in-7",level:4},{value:"fontSize",id:"fontsize",level:3},{value:"Default",id:"default-5",level:4},{value:"Defined in",id:"defined-in-8",level:4},{value:"lineNumbers",id:"linenumbers",level:3},{value:"Default",id:"default-6",level:4},{value:"Defined in",id:"defined-in-9",level:4},{value:"tabSize",id:"tabsize",level:3},{value:"Default",id:"default-7",level:4},{value:"Defined in",id:"defined-in-10",level:4},{value:"theme",id:"theme",level:3},{value:"Default",id:"default-8",level:4},{value:"Defined in",id:"defined-in-11",level:4},{value:"themeColor",id:"themecolor",level:3},{value:"Default",id:"default-9",level:4},{value:"Defined in",id:"defined-in-12",level:4},{value:"useTabs",id:"usetabs",level:3},{value:"Default",id:"default-10",level:4},{value:"Defined in",id:"defined-in-13",level:4},{value:"wordWrap",id:"wordwrap",level:3},{value:"Default",id:"default-11",level:4},{value:"Defined in",id:"defined-in-14",level:4}];function h(e){let n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,l.a)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.header,{children:(0,s.jsx)(n.h1,{id:"interface-editorconfig",children:"Interface: EditorConfig"})}),"\n",(0,s.jsx)(n.h2,{id:"extended-by",children:"Extended by"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsx)(n.li,{children:(0,s.jsx)(n.a,{href:"/docs/api/internal/interfaces/UserConfig",children:(0,s.jsx)(n.code,{children:"UserConfig"})})}),"\n"]}),"\n",(0,s.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,s.jsx)(n.h3,{id:"closebrackets",children:"closeBrackets"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"closeBrackets"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Use auto-complete to close brackets and quotes."}),"\n",(0,s.jsx)(n.h4,{id:"default",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"true\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:801"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editor",children:"editor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"editor"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:'"auto"'})," | ",(0,s.jsx)(n.code,{children:'"monaco"'})," | ",(0,s.jsx)(n.code,{children:'"codemirror"'})," | ",(0,s.jsx)(n.code,{children:'"codejar"'})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Selects the ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings#code-editor",children:"code editor"})," to use."]}),"\n",(0,s.jsxs)(n.p,{children:["If ",(0,s.jsx)(n.code,{children:"undefined"})," (the default), Monaco editor is used on desktop,\nCodeMirror is used on mobile and in ",(0,s.jsx)(n.code,{children:"simple"})," mode,\nwhile CodeJar is used in ",(0,s.jsx)(n.code,{children:"codeblock"})," mode, in ",(0,s.jsx)(n.code,{children:"lite"})," mode and in ",(0,s.jsx)(n.code,{children:"readonly"})," playgrounds."]}),"\n",(0,s.jsxs)(n.p,{children:["If set to ",(0,s.jsx)(n.code,{children:"auto"}),", Monaco editor is used on desktop and CodeMirror is used on mobile regardless of other settings."]}),"\n",(0,s.jsx)(n.h4,{id:"default-1",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-1",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:722"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editormode",children:"editorMode"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"editorMode"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:'"vim"'})," | ",(0,s.jsx)(n.code,{children:'"emacs"'})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings#editor-modes",children:"editor mode"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-2",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:812"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"editortheme",children:"editorTheme"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"editorTheme"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})," | ",(0,s.jsx)(n.a,{href:"/docs/api/internal/type-aliases/EditorTheme",children:(0,s.jsx)(n.code,{children:"EditorTheme"})}),"[]"]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings",children:"code editor"})," themes."]}),"\n",(0,s.jsxs)(n.p,{children:["See docs for ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/configuration/configuration-object#editortheme",children:"editor themes"})," for details."]}),"\n",(0,s.jsx)(n.h4,{id:"examples",children:"Examples"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"vs"\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"monaco:twilight, codemirror:one-dark"\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'["vs@light"]\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'["vs@light", "vs-dark@dark"]\n'})}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'["monaco:vs@light", "codemirror:github-light@light", "dracula@dark"]\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-3",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:748"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"emmet",children:"emmet"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"emmet"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Enables ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings#emmet",children:"Emmet"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-2",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"true\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-4",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:807"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"enableai",children:"enableAI"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"enableAI"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["If ",(0,s.jsx)(n.code,{children:"true"}),", ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/ai",children:"AI code assistant"})," is enabled."]}),"\n",(0,s.jsx)(n.h4,{id:"default-3",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-5",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:818"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"foldregions",children:"foldRegions"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"foldRegions"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["When set to ",(0,s.jsx)(n.code,{children:"true"}),", regions marked by ",(0,s.jsx)(n.code,{children:"#region"})," and ",(0,s.jsx)(n.code,{children:"#endregion"})," comments are folded when the project is loaded."]}),"\n",(0,s.jsx)(n.h4,{id:"default-4",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-6",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:795"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fontfamily",children:"fontFamily"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"fontFamily"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings",children:"code editor"})," font family."]}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-7",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:753"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"fontsize",children:"fontSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"fontSize"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Sets the font size."}),"\n",(0,s.jsxs)(n.p,{children:["If ",(0,s.jsx)(n.code,{children:"undefined"})," (the default), the font size is set to 14 for the full app and 12 for ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/embeds",children:"embeds"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-5",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-8",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:761"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"linenumbers",children:"lineNumbers"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"lineNumbers"}),": ",(0,s.jsx)(n.code,{children:"boolean"})," | ",(0,s.jsx)(n.code,{children:'"relative"'})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Show line numbers in ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/editor-settings",children:"code editor"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-6",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"true\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-9",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:783"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"tabsize",children:"tabSize"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"tabSize"}),": ",(0,s.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"The number of spaces per indentation-level."}),"\n",(0,s.jsxs)(n.p,{children:["Also used in ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/code-format",children:"code formatting"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-7",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"2\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-10",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:777"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"theme",children:"theme"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"theme"}),": ",(0,s.jsx)(n.a,{href:"/docs/api/internal/type-aliases/Theme",children:(0,s.jsx)(n.code,{children:"Theme"})})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the app ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/themes",children:"theme"})," to light/dark mode."]}),"\n",(0,s.jsx)(n.h4,{id:"default-8",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:'"dark"\n'})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-11",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:728"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"themecolor",children:"themeColor"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"themeColor"}),": ",(0,s.jsx)(n.code,{children:"undefined"})," | ",(0,s.jsx)(n.code,{children:"string"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["Sets the app theme color.\nIf ",(0,s.jsx)(n.code,{children:"undefined"}),", it is set to ",(0,s.jsx)(n.code,{children:'"hsl(214, 40%, 50%)"'}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-9",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"undefined\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-12",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:735"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"usetabs",children:"useTabs"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"useTabs"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsxs)(n.p,{children:["If ",(0,s.jsx)(n.code,{children:"true"}),", lines are indented with tabs instead of spaces."]}),"\n",(0,s.jsxs)(n.p,{children:["Also used in ",(0,s.jsx)(n.a,{href:"https://livecodes.io/docs/features/code-format",children:"code formatting"}),"."]}),"\n",(0,s.jsx)(n.h4,{id:"default-10",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-13",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:769"}),"\n",(0,s.jsx)(n.hr,{}),"\n",(0,s.jsx)(n.h3,{id:"wordwrap",children:"wordWrap"}),"\n",(0,s.jsxs)(n.blockquote,{children:["\n",(0,s.jsxs)(n.p,{children:[(0,s.jsx)(n.strong,{children:"wordWrap"}),": ",(0,s.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,s.jsx)(n.p,{children:"Enables word-wrap for long lines."}),"\n",(0,s.jsx)(n.h4,{id:"default-11",children:"Default"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-ts",children:"false\n"})}),"\n",(0,s.jsx)(n.h4,{id:"defined-in-14",children:"Defined in"}),"\n",(0,s.jsx)(n.p,{children:"models.ts:789"})]})}function a(e={}){let{wrapper:n}={...(0,l.a)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},65:function(e,n,d){d.d(n,{Z:function(){return c},a:function(){return r}});var i=d(7294);let s={},l=i.createContext(s);function r(e){let n=i.useContext(l);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:r(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); |