0.0.1 • Published 5 years ago
@penkz/code-editor v0.0.1
CodeEditor
CodeEditor wrappers a CodeMirror editor in a Angular library for use with Angular Forms. Several features have been added to make it easier to use in your applications.
Table of contents
Features
- Compatible with Angular Forms (Both Reactive and Template-driven forms).
- Automatic import of code modes.
- Automatic import of styles.
- Toolbar with configurable options
- Footer with configurable options
Getting started
Step 1: Install CodeEditor:
NPM
npm i @penkz/code-editorStep 2: Import the CodeEditorModule:
import {CodeEditorModule} from '@penkz/code-editor';
@NgModule({
declarations: [AppComponent],
imports: [CodeEditorModule],
bootstrap: [AppComponent]
})
export class AppModule {}Usage sample
<code-editor
[(ngModel)]="model"
></code-editor>API
Inputs
| Input | Type | Default | Required | Description |
|---|---|---|---|---|
| title | string | _ | no | History identifier of history list. When valid history identifier is given, then component stores selected item to local storage of user's browser. If it is null then history is hidden. History list is visible if at least one history item is stored. History identifier must be unique. |
| placeHolder | string | - | no | HTML <input> placeholder text. |
| (ngModel) | any | _ | no | Tracks the value bound to this directive. Used with Template-driven forms. For more details click here |
| formControl / formControlName | string | _ | no | Tracks the FormControl instance bound to the directive. Used with Reactive forms. For more details click here and here |
| isLoading | boolean | false | no | Set the loading state when data is being loaded. |
| disabled | boolean | false | no | input disable/enable. |
Outputs
| Output | Description |
|---|---|
| (change) | Event is emitted when an input is changed. |
| (focus) | Event is emitted when an input is focused. |
Methods (controls)
| Name | Description |
|---|---|
| clear | Clears the editor text |
Versioning
We use Semantic for versioning.
For the versions available, see the tags on this repository.
