@snack-uikit/code-editor 0.4.7-preview-ac85ab7b.0 → 0.4.7-preview-aa6874cd.0

package/README.md

@@ -12,6 +12,36 @@
 ### Props
 | name | type | default value | description |
 |------|------|---------------|-------------|
+| themeName | `string` | - | Название текущей темы. Значение не важно, важно что смена значения запускает пересчет стилей. |
+| hasBackground | `boolean` | true | Включение/отключение псевдобекграунда |
+| yamlSchema | `SchemasSettings` | - | Схема для yaml валидации |
+| defaultValue | `string` | - | Default value of the current model |
+| defaultLanguage | `string` | - | Default language of the current model |
+| defaultPath | `string` | - | Default path of the current model Will be passed as the third argument to `.createModel` method `monaco.editor.createModel(..., ..., monaco.Uri.parse(defaultPath))` |
+| value | `string` | - | Value of the current model |
+| language | `string` | - | Language of the current model |
+| path | `string` | - | Path of the current model Will be passed as the third argument to `.createModel` method `monaco.editor.createModel(..., ..., monaco.Uri.parse(defaultPath))` |
+| theme | `string` | "light" | The theme for the monaco Available options "vs-dark" \| "light" Define new themes by `monaco.editor.defineTheme` |
+| line | `number` | - | The line to jump on it |
+| loading | `ReactNode` | "Loading..." | The loading screen before the editor will be mounted |
+| options | `IStandaloneEditorConstructionOptions` | - | IStandaloneEditorConstructionOptions |
+| overrideServices | `IEditorOverrideServices` | - | IEditorOverrideServices |
+| saveViewState | `boolean` | - | Indicator whether to save the models' view states between model changes or not Defaults to true |
+| keepCurrentModel | `boolean` | false | Indicator whether to dispose the current model when the Editor is unmounted or not |
+| width | `string \| number` | "100%" | Width of the editor wrapper |
+| height | `string \| number` | "100%" | Height of the editor wrapper |
+| className | `string` | - | Class name for the editor container |
+| wrapperProps | `object` | - | Props applied to the wrapper element |
+| beforeMount | `BeforeMount` | - | Signature: function(monaco: Monaco) => void An event is emitted before the editor is mounted It gets the monaco instance as a first argument Defaults to "noop" |
+| onMount | `OnMount` | - | Signature: function(editor: monaco.editor.IStandaloneCodeEditor, monaco: Monaco) => void An event is emitted when the editor is mounted It gets the editor instance as a first argument and the monaco instance as a second Defaults to "noop" |
+| onChange | `OnChange` | - | Signature: function(value: string \| undefined, ev: monaco.editor.IModelContentChangedEvent) => void An event is emitted when the content of the current model is changed |
+| onValidate | `OnValidate` | - | Signature: function(markers: monaco.editor.IMarker[]) => void An event is emitted when the content of the current model is changed and the current model markers are ready Defaults to "noop" |
 
 
 [//]: DOCUMENTATION_SECTION_END
+
+### Поддержка YAML
+Для обеспечения полноценной работы YAML Monaco Editor необходимо подключить `yaml.worker`. Это можно сделать следующими способами: с использованием [`window.MonacoEnvironment`](https://www.npmjs.com/package/monaco-yaml#usage) или с помощью плагина [`MonacoWebpackPlugin`](https://www.npmjs.com/package/monaco-yaml#using-monaco-webpack-loader-plugin) . Подробнее с `monaco-yaml` можно ознакомиться [тут]((https://www.npmjs.com/package/monaco-yaml))
+
+### Как редактор загружает worker?
+Для storybook воркеры определены и расширены `yaml` в настройках вебпака сторибука. Плагин создает новые точки входа каждого build-in воркера и для каждого дабавленного отдельно. Плагин создат глобальную переменную, используя которую редкатор будет загружать нужный воркер на основе текущего `language`.

package/dist/cjs/components/types.d.ts

@@ -5,5 +5,8 @@ export type EditorProps = {
 } & MonacoEditorProps;
 export type YamlEditorProps = {
     language: 'yaml';
+    /**
+     * Схема для yaml валидации
+     */
     yamlSchema?: SchemasSettings;
 } & Omit<MonacoEditorProps, 'language'>;

package/dist/esm/components/types.d.ts

@@ -5,5 +5,8 @@ export type EditorProps = {
 } & MonacoEditorProps;
 export type YamlEditorProps = {
     language: 'yaml';
+    /**
+     * Схема для yaml валидации
+     */
     yamlSchema?: SchemasSettings;
 } & Omit<MonacoEditorProps, 'language'>;

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.4.7-preview-ac85ab7b.0",
+  "version": "0.4.7-preview-aa6874cd.0",
   "sideEffects": [
     "*.css",
     "*.woff",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "@types/chroma-js": "2.4.4"
   },
-  "gitHead": "b48c28c30724091afb0c9c00a9f06a0d8fdaa943"
+  "gitHead": "e8e7969f21fb78891213f7bac60d2c87ceb7b8f9"
 }

package/src/components/types.ts

@@ -7,5 +7,8 @@ export type EditorProps = {
 
 export type YamlEditorProps = {
   language: 'yaml';
+  /**
+   * Схема для yaml валидации
+   */
   yamlSchema?: SchemasSettings;
 } & Omit<MonacoEditorProps, 'language'>;