[Emotion] Convert euiFocusRing() mixin
#5855
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| import { css } from '@emotion/react'; | ||
| import React from 'react'; | ||
|
|
||
| import { | ||
| EuiCode, | ||
| euiScreenReaderOnlyStyles, | ||
| EuiText, | ||
| useEuiFocusRing, | ||
| } from '../../../../src'; | ||
| import { useEuiTheme } from '../../../../src/services'; | ||
| import { ThemeExample } from '../theme/_components/_theme_example'; | ||
|
|
||
| export default () => { | ||
| const { euiTheme } = useEuiTheme(); | ||
|
|
||
| return ( | ||
| <> | ||
| <ThemeExample | ||
| title={<code>.euiScreenReaderOnly</code>} | ||
| description={ | ||
| <p> | ||
| This utility class allows you to apply the screen reader only CSS | ||
| styles directly to your component. | ||
| </p> | ||
| } | ||
| example={ | ||
| <EuiText size="s"> | ||
| <p>The next paragraph is hidden except for screen readers.</p> | ||
| <p className="euiScreenReaderOnly"> | ||
| I am hidden except for screen readers | ||
| </p> | ||
| </EuiText> | ||
| } | ||
| snippet={'<p className="euiScreenReaderOnly" />'} | ||
| /> | ||
| <ThemeExample | ||
| title={<code>euiScreenReaderOnlyStyles()</code>} | ||
| description={ | ||
| <p> | ||
| This function allows you to apply the screen reader only CSS styles | ||
| directly to your component. | ||
| </p> | ||
| } | ||
| example={ | ||
| <EuiText size="s"> | ||
| <p>The next paragraph is hidden except for screen readers.</p> | ||
| <p css={css(euiScreenReaderOnlyStyles())}> | ||
| I am hidden except for screen readers | ||
| </p> | ||
| </EuiText> | ||
| } | ||
| snippet={'<p css={css(euiScreenReaderOnlyStyles())} />'} | ||
| /> | ||
| <ThemeExample | ||
| title={<code>useEuiFocusRing(offset?, color?)</code>} | ||
| description={ | ||
| <p> | ||
| By default, all interactable elements will inherit the{' '} | ||
| <EuiCode>outline</EuiCode> property from the reset file. However, | ||
| some instances require adjustment to the <EuiCode>offset</EuiCode>{' '} | ||
| and <EuiCode>color</EuiCode> of this outline. This helper function | ||
| allows that customization of the focus outline. | ||
| </p> | ||
| } | ||
| props={`offset: 'inset' | 'outset' | 'center' | CSSProperties['outlineOffset']; | ||
|
|
||
| color: CSSProperties['outlineColor'];`} | ||
| example={ | ||
| <EuiText size="s"> | ||
| <p> | ||
| <button> | ||
| I am an unstyled <EuiCode>button</EuiCode> with inherited | ||
| outline | ||
| </button> | ||
| </p> | ||
| <p> | ||
| <button | ||
| css={css` | ||
| &:focus { | ||
| ${useEuiFocusRing('outset', euiTheme.colors.primary)} | ||
| } | ||
| `} | ||
| > | ||
| I am an unstyled <EuiCode>button</EuiCode> with an{' '} | ||
| <EuiCode>outset, primary</EuiCode> outline | ||
| </button> | ||
| </p> | ||
| </EuiText> | ||
| } | ||
| snippetLanguage="emotion" | ||
| snippet={`&:focus { | ||
| \${useEuiFocusRing('outset', euiTheme.colors.primary)} | ||
| }`} | ||
| /> | ||
| </> | ||
| ); | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,73 @@ | ||
| import React from 'react'; | ||
|
|
||
| import { | ||
| useEuiTheme, | ||
| EuiTitle, | ||
| EuiSpacer, | ||
| EuiText, | ||
| EuiPanel, | ||
| } from '../../../../../src'; | ||
|
|
||
| import { getPropsFromComponent } from '../../../services/props/get_props'; | ||
| import { useDebouncedUpdate } from '../hooks'; | ||
|
|
||
| import { ThemeValue } from './_values'; | ||
|
|
||
| import { EuiThemeFocus } from '../_props'; | ||
|
|
||
| export default ({ onThemeUpdate }) => { | ||
| const { euiTheme } = useEuiTheme(); | ||
| const focus = euiTheme.focus; | ||
|
|
||
| const [focusClone, updateFocus] = useDebouncedUpdate({ | ||
| property: 'focus', | ||
| value: focus, | ||
| onUpdate: onThemeUpdate, | ||
| }); | ||
|
|
||
| const focusProps = getPropsFromComponent(EuiThemeFocus); | ||
|
|
||
| return ( | ||
| <div> | ||
| <EuiText> | ||
| <h2>Focus</h2> | ||
| </EuiText> | ||
| <EuiSpacer size="xl" /> | ||
| <EuiPanel color="subdued"> | ||
| <EuiTitle size="xs"> | ||
| <h3> | ||
| <code>_EuiThemeFocus</code> | ||
| </h3> | ||
| </EuiTitle> | ||
| <EuiSpacer size="s" /> | ||
| <EuiText size="s" grow={false}> | ||
| <p> | ||
| These are general properties that apply to the focus state of | ||
| interactable components. Some components have their own specific | ||
| implementation, but most use these variables. | ||
| </p> | ||
| </EuiText> | ||
|
|
||
| <EuiSpacer /> | ||
|
|
||
| {Object.keys(focusProps).map((prop) => { | ||
| return ( | ||
| <ThemeValue | ||
| key={prop} | ||
| property="focus" | ||
| type={focusProps[prop]} | ||
| name={prop} | ||
| value={focusClone[prop]} | ||
| onUpdate={(value) => updateFocus(prop, value)} | ||
| forceUpdateType="string" | ||
| example={null} | ||
| numberProps={{ | ||
| style: { width: 140 }, | ||
| }} | ||
| /> | ||
| ); | ||
| })} | ||
| </EuiPanel> | ||
| </div> | ||
| ); | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe you should list what are the available offset options:
'inset' | 'outset' | 'center' | CSSProperties['outlineOffset']. I'm just thinking what if I'm using this hook without TS?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah it starts getting into the territory of having to duplicate prop types. I wonder if there's a way we can do this programmatically instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went ahead and added this one in manually, making space for it in the re-used component
ThemeExample. I'm hoping someone smarter than me will be able to create a re-usable service 😸