Skip to content
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

VS Code snippet for component styles. #6259

Merged
merged 2 commits into from
Sep 23, 2022
Merged

VS Code snippet for component styles. #6259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33e6147
VS Code snippet for component styles.
daveyholler Sep 21, 2022
e28e639
Adds link to VS Code docs.
daveyholler Sep 22, 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
39 changes: 39 additions & 0 deletions wiki/writing-styles-with-emotion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,45 @@ export const euiComponentNameStyles = ({ euiTheme }: UseEuiTheme) => {
};
```

---
<details>
<summary>🎉 <b>ProTip:</b> VS Code snippet</summary>
To make generating component boilerplate just a little bit easier, you can add the following block to a global or local snippet file in VS Code. Once saved, you'll be able to generate the boilerplate by typing `euisc` `tab`. <a href="https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets" target="_blank">Learn how to add snippets in VS Code</a>:

```json
"euiStyledComponent": {
"prefix": "euisc",
"body": [
"/*",
"* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one",
"* or more contributor license agreements. Licensed under the Elastic License",
"* 2.0 and the Server Side Public License, v 1; you may not use this file except",
"* in compliance with, at your election, the Elastic License 2.0 or the Server",
"* Side Public License, v 1.",
"*/",
"",
"import { css } from '@emotion/react';",
"import {",
" euiFontSize,",
" logicalCSS,",
"} from '../../global_styling';",
"import { UseEuiTheme } from '../../services';",
"",
"export const ${1:componentName}Styles = ({ euiTheme }: UseEuiTheme) => {",
" return {",
" ${1:componentName}: css`",
" ${2:property}: tomato;",
" `",
" };",
"};"
],
"description": "EUI styled component"
}
```
</details>

---

```tsx
/* {component name}.tsx */
import { useEuiTheme } from '../../services';
Expand Down