Skip to content

chore(code editor): Convert examples to TypeScript/Functional components #7101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolethoen merged 5 commits into from
Apr 8, 2022
Merged

chore(code editor): Convert examples to TypeScript/Functional components #7101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
10010ea
add basic and size to fit tsx files
jenny-s51 Mar 21, 2022
1864ff5
add all examples
jenny-s51 Mar 21, 2022
8db99c4
resolve TS error in code shortcut example
jenny-s51 Mar 21, 2022
6bd98d4
PR feedback from Katie
jenny-s51 Mar 23, 2022
737612c
rename function components to match file names
jenny-s51 Apr 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
270 changes: 8 additions & 262 deletions packages/react-code-editor/src/components/CodeEditor/examples/CodeEditor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,284 +12,30 @@ import { CodeEditor, CodeEditorControl, Language } from '@patternfly/react-code-
import PlayIcon from '@patternfly/react-icons/dist/esm/icons/play-icon';

## Examples

### Basic
```js
import React from 'react';
import { CodeEditor, Language } from '@patternfly/react-code-editor';
import { Checkbox } from '@patternfly/react-core';

class BasicCodeEditor extends React.Component {
constructor(props) {
super(props);
this.state = {
isDarkTheme: false,
isLineNumbersVisible: true,
isReadOnly: false,
isMinimapVisible: true
};

this.toggleDarkTheme = checked => {
this.setState({
isDarkTheme: checked
});
};
this.toggleLineNumbers = checked => {
this.setState({
isLineNumbersVisible: checked
});
};
this.toggleReadOnly = checked => {
this.setState({
isReadOnly: checked
});
};
this.toggleMinimap = checked => {
this.setState({
isMinimapVisible: checked
})
};

this.onEditorDidMount = (editor, monaco) => {
console.log(editor.getValue());
editor.layout();
editor.focus();
monaco.editor.getModels()[0].updateOptions({ tabSize: 5 });
};

this.onChange = value => {
console.log(value);
};
}

render() {
const { isDarkTheme, isLineNumbersVisible, isReadOnly, isMinimapVisible } = this.state;

return (
<>
<Checkbox
label="Dark theme"
isChecked={isDarkTheme}
onChange={this.toggleDarkTheme}
aria-label="dark theme checkbox"
id="toggle-theme"
name="toggle-theme"
/>
<Checkbox
label="Line numbers"
isChecked={isLineNumbersVisible}
onChange={this.toggleLineNumbers}
aria-label="line numbers checkbox"
id="toggle-line-numbers"
name="toggle-line-numbers"
/>
<Checkbox
label="Read only"
isChecked={isReadOnly}
onChange={this.toggleReadOnly}
aria-label="read only checkbox"
id="toggle-read-only"
name="toggle-read-only"
/>
<Checkbox
label="Minimap"
isChecked={isMinimapVisible}
onChange={this.toggleMinimap}
aria-label="display minimap checkbox"
id="toggle-minimap"
name="toggle-minimap"
/>
<CodeEditor
isDarkTheme={isDarkTheme}
isLineNumbersVisible={isLineNumbersVisible}
isReadOnly={isReadOnly}
isMinimapVisible={isMinimapVisible}
isLanguageLabelVisible
code="Some example content"
onChange={this.onChange}
language={Language.javascript}
onEditorDidMount={this.onEditorDidMount}
height='400px'
/>
</>
);
}
}
```ts file="./CodeEditorBasic.tsx"
```

### With sizeToFit height, height will grow/shrink with content
```js
import React from 'react';
import { CodeEditor, Language } from '@patternfly/react-code-editor';

class BasicCodeEditor extends React.Component {
constructor(props) {
super(props);

this.onEditorDidMount = (editor, monaco) => {
console.log(editor.getValue());
editor.layout();
editor.focus();
monaco.editor.getModels()[0].updateOptions({ tabSize: 5 });
};

this.onChange = value => {
console.log(value);
};
}

render() {
return (
<CodeEditor
code="Some example content"
onChange={this.onChange}
language={Language.javascript}
onEditorDidMount={this.onEditorDidMount}
height='sizeToFit'
/>
);
}
}
```ts file="./CodeEditorSizeToFit.tsx"
```

### With shortcut menu and main header content.
### With shortcut menu and main header content

These examples below are the shortcuts that we recommend describing in the popover since they are monaco features.
```js
import React from 'react';
import { CodeEditor, Language } from '@patternfly/react-code-editor';
import { Checkbox, Grid, GridItem, Chip } from '@patternfly/react-core';

class BasicCodeEditor extends React.Component {
constructor(props) {
super(props);

this.onEditorDidMount = (editor, monaco) => {
console.log(editor.getValue());
editor.layout();
editor.focus();
monaco.editor.getModels()[0].updateOptions({ tabSize: 5 });
};

this.onChange = value => {
console.log(value);
};
}

render() {
const shortcuts = [
{
keys: ["Opt","F1"],
description: "Accessibility helps",
},
{
keys: ["F1"],
description: "View all editor shortcuts",
},
{
keys: ["Ctrl", "Space"],
description: "Activate auto complete",
},
{
keys: ["Cmd", "S"],
description: "Save",
},
];
const shortcutsPopoverProps = {
bodyContent:
<Grid span={6} hasGutter>
{shortcuts.map(s => (
<>
<GridItem style={{ textAlign: 'right', marginRight: '1em' }}>
{s.keys
.map(k => (
<Chip key={k} isReadOnly>
{k}
</Chip>
))
.reduce((prev, curr) => [prev, ' + ', curr])}
</GridItem>
<GridItem>{s.description}</GridItem>
</>
))}
</Grid>,
'aria-label': "Shortcuts",
}

return (
<>
<CodeEditor
headerMainContent="Shortcut Example"
shortcutsPopoverProps={shortcutsPopoverProps}
isLanguageLabelVisible
code="Some example content"
onChange={this.onChange}
language={Language.javascript}
onEditorDidMount={this.onEditorDidMount}
height='400px'
/>
</>
);
}
}
```ts file="./CodeEditorShortcutMainHeader.tsx"
```

### With actions
```js
import React from 'react';
import { CodeEditor } from '@patternfly/react-code-editor';

<CodeEditor
isUploadEnabled
isDownloadEnabled
isCopyEnabled
isLanguageLabelVisible
height='400px'
/>
```ts file="./CodeEditorWithActions.tsx"
```

### With custom control
```js
import React from 'react';
import { CodeEditor, CodeEditorControl } from '@patternfly/react-code-editor';
import PlayIcon from '@patternfly/react-icons/dist/esm/icons/play-icon';

class customControlExample extends React.Component {
constructor(props) {
super(props);
this.state = {
code: ''
};

this.onChange = code => {
this.setState({ code })
};

this.onExecuteCode = (code) => {
console.log(code);
};
}

render() {
const customControl = (
<CodeEditorControl
icon={<PlayIcon/>}
aria-label="Execute code"
toolTipText="Execute code"
onClick={this.onExecuteCode}
isVisible={this.state.code !== ''}
/>);

return (
<>
<CodeEditor
isDownloadEnabled
isCopyEnabled
height='400px'
customControls={customControl}
code={this.state.code}
onChange={this.onChange}
/>
</>
);
}
}
```ts file="CodeEditorCustomControl.tsx"
```
86 changes: 86 additions & 0 deletions packages/react-code-editor/src/components/CodeEditor/examples/CodeEditorBasic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import React from 'react';
import { CodeEditor, Language } from '@patternfly/react-code-editor';
import { Checkbox } from '@patternfly/react-core';

export const CodeEditorBasic: React.FunctionComponent = () => {
const [isDarkTheme, setIsDarkTheme] = React.useState(false);
const [isLineNumbersVisible, setIsLineNumbersVisible] = React.useState(true);
const [isReadOnly, setIsReadOnly] = React.useState(false);
const [isMinimapVisible, setIsMinimapVisible] = React.useState(false);

const toggleDarkTheme = checked => {
setIsDarkTheme(checked);
};

const toggleLineNumbers = checked => {
setIsLineNumbersVisible(checked);
};
const toggleReadOnly = checked => {
setIsReadOnly(checked);
};
const toggleMinimap = checked => {
setIsMinimapVisible(checked);
};

const onEditorDidMount = (editor, monaco) => {
// eslint-disable-next-line no-console
console.log(editor.getValue());
editor.layout();
editor.focus();
monaco.editor.getModels()[0].updateOptions({ tabSize: 5 });
};

const onChange = value => {
// eslint-disable-next-line no-console
console.log(value);
};

return (
<>
<Checkbox
label="Dark theme"
isChecked={isDarkTheme}
onChange={toggleDarkTheme}
aria-label="dark theme checkbox"
id="toggle-theme"
name="toggle-theme"
/>
<Checkbox
label="Line numbers"
isChecked={isLineNumbersVisible}
onChange={toggleLineNumbers}
aria-label="line numbers checkbox"
id="toggle-line-numbers"
name="toggle-line-numbers"
/>
<Checkbox
label="Read only"
isChecked={isReadOnly}
onChange={toggleReadOnly}
aria-label="read only checkbox"
id="toggle-read-only"
name="toggle-read-only"
/>
<Checkbox
label="Minimap"
isChecked={isMinimapVisible}
onChange={toggleMinimap}
aria-label="display minimap checkbox"
id="toggle-minimap"
name="toggle-minimap"
/>
<CodeEditor
isDarkTheme={isDarkTheme}
isLineNumbersVisible={isLineNumbersVisible}
isReadOnly={isReadOnly}
isMinimapVisible={isMinimapVisible}
isLanguageLabelVisible
code="Some example content"
onChange={onChange}
language={Language.javascript}
onEditorDidMount={onEditorDidMount}
height="400px"
/>
</>
);
};
Loading