Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
98 commits
Select commit Hold shift + click to select a range
6598a42
Fix typo in EuiBasicTable documentation (#2041)
justinkambic Jun 13, 2019
878c963
EuiColorPicker uses standard portal DOM positioning, intentional popo…
thompsongl Jun 14, 2019
5c593ae
update i18ntokens
thompsongl Jun 14, 2019
6077444
12.0.0
thompsongl Jun 14, 2019
cd70799
Updated documentation.
thompsongl Jun 14, 2019
4b9ca7a
Add 11.3.2 (backport) CL section
thompsongl Jun 14, 2019
99814cf
Make the commit hook (via yarn lint-es) fail on lint warnings (#2046)
chandlerprall Jun 14, 2019
9822150
(Accessibility) Fix EuiNavDrawerFlyout using `<h5>` by replacing with…
PhilippBaranovskiy Jun 17, 2019
9e6504f
Properly handle Function and TSMethodSignature TS interfaces and type…
chandlerprall Jun 17, 2019
181f011
fix changelog
chandlerprall Jun 17, 2019
259bb61
Update EUI writing guidelines to include title casing feature names (…
Zacqary Jun 18, 2019
5b059ee
Update diff and is-my-json-valid version (#2047)
chandlerprall Jun 18, 2019
621fd55
Allow sorting by computed columns in EuiInMemoryTable (#2044)
chandlerprall Jun 18, 2019
7de5b20
Export `Toast` TS member (#2052)
thompsongl Jun 18, 2019
8afcf46
Minify the docs build (#2053)
pugnascotia Jun 18, 2019
b0ac716
Add magnifyWithMinus and magnifyWithPlus (aka zoom) icons (#2056)
ryankeairns Jun 19, 2019
35f0931
Added a fully black color variable `$euiColorInk` (#2060)
cchaos Jun 19, 2019
a3276cd
Fix readonly input groups (#2057)
cchaos Jun 19, 2019
c745a3c
Update README.md with example for react-router v5 (#1976)
sebelga Jun 20, 2019
7fe794a
(Accessibility) NVDA/JAWS support for `EuiGlobalToastList` (#2055)
PhilippBaranovskiy Jun 20, 2019
c107d3a
Added `autoFocus` option to `EuiTabbedContent` (#2062)
cchaos Jun 20, 2019
bb41f02
update popout icon (#2064)
ryankeairns Jun 20, 2019
0ce3e6b
SuperDatePicker tweaks to make it selection more obvious (#2049)
cchaos Jun 20, 2019
765704b
Strip TS type exports even when they are being renamed (#2069)
chandlerprall Jun 20, 2019
82f22d8
Pass EuiSuperSelect's popoverClassName to the popover's panel (#2068)
Jun 20, 2019
a11b00b
adds editor align and dist glyphs (#2070)
ryankeairns Jun 21, 2019
bcf5140
[EuiRange] Add missing TS definitions (#2072)
sulemanof Jun 21, 2019
aff5d2a
EuiBadge and EuiCopy TS fixes (#2075)
thompsongl Jun 25, 2019
b4c84db
update i18ntokens
thompsongl Jun 25, 2019
bc31d87
12.1.0
thompsongl Jun 25, 2019
8d9d8a9
Updated documentation.
thompsongl Jun 25, 2019
391dba2
[Accessibility] Allow setting of the aria-label of table row selectio…
PhilippBaranovskiy Jun 25, 2019
83b2832
Require that FormRow has exactly one child element (#2054)
Jun 25, 2019
9b4479d
Move 2043 entry to master
thompsongl Jun 25, 2019
4c2defb
[Icons] Updated APM app and solution logos (#2084)
formgeist Jul 1, 2019
885b901
12.2.0
snide Jul 1, 2019
b6381a1
Updated documentation.
snide Jul 1, 2019
2e7ad84
Update combobox option's value TS definition (#2080)
chandlerprall Jul 1, 2019
f71f602
Move 2080 to master
thompsongl Jul 1, 2019
c1b3c65
Added a `column` direction option to EuiFlexGrid (#2073)
cchaos Jul 2, 2019
e4db15d
React datepicker better responsive handling when inline (#1820)
snide Jul 2, 2019
f5a3035
Convert form control layout to ts (#2086)
chandlerprall Jul 5, 2019
58473fa
Allow ESC to propagate if `EuiPopover` is not open (#2089)
thompsongl Jul 8, 2019
9318b07
Clean up packaged npm distributable (#2096)
chandlerprall Jul 8, 2019
a61339b
Use `mask-image` for overflow shadows (#2088)
cchaos Jul 8, 2019
2c40ae3
Add tips for snippets
ryankeairns Jul 10, 2019
8c997ff
Add tips for snippets
ryankeairns Jul 10, 2019
ee432d0
Add snippets to navigation components (#2093)
andreadelrio Jul 10, 2019
0ef6233
minor comment change (#2103)
varunsharma27 Jul 10, 2019
f571074
Wiki and docs updates (#2101)
snide Jul 10, 2019
1f04d2b
Upgrade react-datepicker's version of lodash.mergewit to 4.6.2 (#2105)
chandlerprall Jul 12, 2019
9813867
Add security, logging, maps, uptime and code solution icons (#2111)
snide Jul 12, 2019
a5d1823
Fixed placeholder text color for more browsers (#2113)
cchaos Jul 12, 2019
389a0e7
Added `display` prop to EuiPopover (#2112)
cchaos Jul 12, 2019
3a5023b
update i18ntokens
Jul 12, 2019
f0a10b6
12.3.0
snide Jul 12, 2019
2c0e734
Updated documentation.
snide Jul 12, 2019
fab1617
re-include all src scss files and packages/ dir in npm published buil…
chandlerprall Jul 12, 2019
82f9622
12.3.1
chandlerprall Jul 12, 2019
488f921
Updated documentation.
chandlerprall Jul 12, 2019
0e8c8f5
Centered the square of the popout icon in the artboard (#2120)
cchaos Jul 15, 2019
e7662e3
Close EuiComboBox options when the page scrolls (#2106)
chandlerprall Jul 15, 2019
4b06a38
move postcss.config to root (#2116)
thompsongl Jul 15, 2019
abf4d52
`useInnerText`; Fix `EuiListGroupItem` title attrs (#2100)
thompsongl Jul 15, 2019
d4fc5a2
remove postcss config from package.json (#2123)
thompsongl Jul 15, 2019
36251ab
`EuiFormRow` with nested `EuiPopover`s using `ownFocus` (#2110)
thompsongl Jul 15, 2019
c056b4b
Run only tests affected by changes on commit (#2122)
chandlerprall Jul 15, 2019
364b14b
Add new icons (#2102)
Jul 16, 2019
2d84bd2
Add DistributivePick and DistributiveOmit, update EuiFormControlLayou…
chandlerprall Jul 16, 2019
fa84462
Convert a range of `EuiRange*` components to TypeScript (#2124)
thompsongl Jul 16, 2019
2df9248
Convert `EuiAccordion` to TS (#2128)
thompsongl Jul 17, 2019
a27756d
Remove nested array in ES Query DSL generation (#2133)
chandlerprall Jul 17, 2019
0cb0e80
update i18ntokens
bevacqua Jul 17, 2019
dcae42f
12.4.0
bevacqua Jul 17, 2019
d4ce2ab
Updated documentation.
bevacqua Jul 17, 2019
c350f7f
Fixed EuiComboBox padding on the right (#2135)
cchaos Jul 17, 2019
647d946
Expose prettyDuration and commonDurationRanges (#2132)
chandlerprall Jul 18, 2019
d753291
[DEPRECATIONS] Remove EUI Charts, Sass deprecations (#2108)
snide Jul 18, 2019
8ffeb53
12.2.1 backport entry
thompsongl Jul 18, 2019
eb9cce0
Allow EuiSearchBar group clauses to be negated (#2140)
chandlerprall Jul 18, 2019
239ef62
Add a responsive prop
sulemanof Jul 19, 2019
df8c554
Revert "Add a responsive prop"
sulemanof Jul 19, 2019
5643b3c
Add Suggest Item (#2090)
andreadelrio Jul 19, 2019
c5ceab9
Allow nested `EuiAccordion`s (#2136)
thompsongl Jul 19, 2019
3a437bb
Update docs on how to test local EUI in Kibana (#2144)
snide Jul 19, 2019
d5233c3
Attempting to fix with EuiFlyout maxWidth (#2125)
cchaos Jul 20, 2019
894420b
Fix typo in icon docs (#2146)
pugnascotia Jul 22, 2019
f0afef8
Bump stringstream from 0.0.5 to 0.0.6 in /packages/react-datepicker (…
dependabot[bot] Jul 22, 2019
6147e92
Bump merge from 1.2.0 to 1.2.1 in /packages/react-datepicker (#2149)
dependabot[bot] Jul 22, 2019
f08913d
Bump eslint from 4.14.0 to 4.18.2 in /packages/react-datepicker (#2148)
dependabot[bot] Jul 22, 2019
2933a88
Bump lodash from 4.17.4 to 4.17.13 in /packages/react-datepicker (#2147)
dependabot[bot] Jul 22, 2019
4f4a698
Remove EuiFlexGroup dependency from EuiAccordion (#2143)
cchaos Jul 22, 2019
52e76ac
Corrected changelog
chandlerprall Jul 22, 2019
399f30e
Upgrade sidenav search to include sub-section titles (#2151)
chandlerprall Jul 22, 2019
afedd0e
relative link href values (#2154)
thompsongl Jul 22, 2019
cec1874
update i18ntokens
Jul 22, 2019
dcf4bed
13.0.0
snide Jul 22, 2019
9105457
Updated documentation.
snide Jul 22, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 6 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ types/
# ignore everything in `scripts` except postinstall.js
scripts/!(postinstall.js)

src/**/*.!(scss)

.DS_Store
.eslintcache
.idea
Expand All @@ -24,3 +26,7 @@ scripts/!(postinstall.js)
package-lock.json
npm-debug.log
.cache-loader
*.md
yarn-error.log
tsconfig.json
tsconfig-builttypes.json
121 changes: 121 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,116 @@
## [`master`](https://github.com/elastic/eui/tree/master)

No public interface changes since `13.0.0`.

## [`13.0.0`](https://github.com/elastic/eui/tree/v13.0.0)

- Added `EuiSuggestItem` component ([#2090](https://github.com/elastic/eui/pull/2090))
- Added support for negated or clauses to `EuiSearchBar` ([#2140](https://github.com/elastic/eui/pull/2140))
- Added `transition` utility services to help create timeouts that account for CSS transition durations and delays ([#2136](https://github.com/elastic/eui/pull/2136))
- Removed `EuiFlexGroup` dependency from `EuiAccordion` ([#2143](https://github.com/elastic/eui/pull/2143))
- Exported `prettyDuration` and `commonDurationRanges` for pretty printing date ranges outside `EuiSuperDatePicker` ([#2132](https://github.com/elastic/eui/pull/2132))

**Bug fixes**

- Fixed `EuiComboBox`'s padding on the right ([#2135](https://github.com/elastic/eui/pull/2135))
- Fixed `EuiAccordion` to correctly account for changing computed height of child elements ([#2136](https://github.com/elastic/eui/pull/2136))
- Fixed some `EuiFlyout` sizing ([#2125](https://github.com/elastic/eui/pull/2125))

**Breaking changes**

- Removed `EuiSeriesChart` and related components. Please look to [Elastic Charts](https://github.com/elastic/elastic-charts) for a replacement. ([#2135](https://github.com/elastic/eui/pull/2108))
- Removed `eui_k6_theme` related Sass and JSON files ([#2135](https://github.com/elastic/eui/pull/2108))
- Removed no longer used Sass mixins and variables in `EuiForm`, `EuiCallOut`, and `EuiRange` components ([#2135](https://github.com/elastic/eui/pull/2108))

## [`12.4.0`](https://github.com/elastic/eui/tree/v12.4.0)

- Centered the square of the `popout` glyph in the artboard ([#2120](https://github.com/elastic/eui/pull/2120))
- Added `useInnerText` and `EuiInnerText` component utilities for retrieving text content of elements ([#2100](https://github.com/elastic/eui/pull/2100))
- Converted `EuiRangeHightlight`, `EuiRangeLabel`, `EuiRangeLevels`, `EuiRangeSlider`, `EuiRangeThumb`, `EuiRangeTicks`, `EuiRangeTrack`, and `EuiRangeWrapper` to TypeScript ([#2124](https://github.com/elastic/eui/pull/2124))
- Converted `EuiAccordion` to TypeScript ([#2128](https://github.com/elastic/eui/pull/2128))

**Bug fixes**

- Fixed `EuiComboBox`'s options list from staying open when scrolled in a container by auto-closing the list on scroll ([#2106](https://github.com/elastic/eui/pull/2106))
- Fixed content provided to `EuiListGroupItem` and `EuiFilterButton` `title` attribute to prevent unreadable popover ([#2100](https://github.com/elastic/eui/pull/2100))
- Fixed a nearly infinite `requestAnimationFrame` loop caused by `focus` state changes in nested `EuiPopover` components ([#2110](https://github.com/elastic/eui/pull/2110))
- Fixed incorrect ES Query DSL generated by `EuiSearchBar` when an OR clause is present ([#2133](https://github.com/elastic/eui/pull/2133))

## [`12.3.1`](https://github.com/elastic/eui/tree/v12.3.1)

**Bug fixes**

- Restored missing scss and react-datepicker files to the npm-published packaged ([#2119](https://github.com/elastic/eui/pull/2119))

## [`12.3.0`](https://github.com/elastic/eui/tree/v12.3.0)

**Note: this release contained a change which prevented necessary files from being published to npm, this was fixed in 12.3.1**

- Added `logoSecurity`, `logoCode`, `logoMaps`, `logoUptime` and `logoLogging` to `EuiIcon` types ([#2111](https://github.com/elastic/eui/pull/2111))
- Added a `column` direction option to `EuiFlexGrid` ([#2073](https://github.com/elastic/eui/pull/2073))
- Updated `EuiSuperDatePicker`'s commonly used date/times to display as columns. ([#2073](https://github.com/elastic/eui/pull/2073))
- Added TypeScript definition for `EuiFormControlLayout` ([#2086](https://github.com/elastic/eui/pull/2086))
- Changed SASS mixin `euiOverflowShadow()` to use `mask-image` instead of `box-shadow` ([#2088](https://github.com/elastic/eui/pull/2088))
- Added SASS mixin and CSS utility `euiYScrollWithShadows` ([#2088](https://github.com/elastic/eui/pull/2088))
- Added `cloudDrizzle`, `cloudStormy`, `cloudSunny`, `documents`, `documentEdit`, `training` and `videoPlayer` glyphs to `EuiIcon` ([#2102](https://github.com/elastic/eui/pull/2102))
- Added `display` prop to `EuiPopover` ([#2112](https://github.com/elastic/eui/pull/2112))

**Bug fixes**

- Widened `EuiComboBox`'s `options[].value` / `EuiComboBoxOptionProps.value` TypeScript definition ([#2080](https://github.com/elastic/eui/pull/2080))
- Added TS defs for `EuiComboBox`'s props spreading onto a `div` ([#2080](https://github.com/elastic/eui/pull/2080))
- Fixed responsive display of inline `EuiDatePicker` ([#1820](https://github.com/elastic/eui/pull/1820))
- Removed time from default `dateFormat` of `EuiDatePicker` ([#1820](https://github.com/elastic/eui/pull/1820))
- Fixed `EuiPopover` from catching and preventing propagation of keydown events when closed ([#2089](https://github.com/elastic/eui/pull/2089))
- Fixed padding sizes between `EuiModal` header, body, and footer ([#2088](https://github.com/elastic/eui/pull/2088))
- Fixed placeholder text color for more browsers ([#2113](https://github.com/elastic/eui/pull/2113))

**Deprecations**

- Removed `logoXpack`from `EuiIcon` types ([#2111](https://github.com/elastic/eui/pull/2111))

## [`12.2.1`](https://github.com/elastic/eui/tree/v12.2.1)

**Note: this release is a backport containing changes originally made in `12.4.0`**

**Bug fixes**

- Fixed a nearly infinite `requestAnimationFrame` loop caused by `focus` state changes in nested `EuiPopover` components ([#2110](https://github.com/elastic/eui/pull/2110))

## [`12.2.0`](https://github.com/elastic/eui/tree/v12.2.0)

- Made `aria-label` attribute equal to `title` of the the selection checkbox in table items (for each row) in `EuiBasicTable` ([#2043](https://github.com/elastic/eui/pull/2043))
- Updated `appApm` and `logoAPM` with new updated icons ([#2084](https://github.com/elastic/eui/pull/2084))

**Bug fixes**

- Added requirement that `EuiFormRow` has exactly one child element [#2054](https://github.com/elastic/eui/pull/2054)

## [`12.1.0`](https://github.com/elastic/eui/tree/v12.1.0)

- Changed `EuiNavDrawerFlyout` title from `h5` to `div` ([#2040](https://github.com/elastic/eui/pull/2040))
- Converted `EuiGlobalToastList` into ARIA live region by adding `role="region"` attribute to add NVDA/JAWS support ([#2055](https://github.com/elastic/eui/pull/2055))
- Added `magnifyWithMinus` and `magnifyWithPlus` glyphs to `EuiIcon` ([2056](https://github.com/elastic/eui/pull/2056))
- Added a fully black (no matter the theme) color SASS variable `$euiColorInk` ([2060](https://github.com/elastic/eui/pull/2060))
- Added `autoFocus` prop to `EuiTabbedContent` ([2062](https://github.com/elastic/eui/pull/2062))
- Changed `popout` glyph in `EuiIcon` to look more like external link ([2064](https://github.com/elastic/eui/pull/2064))
- Tweaked `SuperDatePicker` to make the start/end date selection more obvious ([#2049](https://github.com/elastic/eui/pull/2049))
- Added `toSentenceCase` string service ([#2049](https://github.com/elastic/eui/pull/2049))
- Pass `EuiSuperSelect`'s `popoverClassName` to the popover's panel ([#2068](https://github.com/elastic/eui/pull/2068))
- Added `editorItemAlignLeft`, `editorItemAlignCenter`, `editorItemRight`, `editorItemAlignTop`, `editorItemAlignMiddle`, `editorItemAlignBottom`, `editorDistributeHorizontal`, `editorDistributeVertical`, `editorPositionTopLeft`, `editorPositionTopRight`, `editorPositionBottomRight`, and `editorPositionBottomLeft` glyphs to `EuiIcon` ([2070](https://github.com/elastic/eui/pull/2070))
- Added missing TS definitions for `EuiRange` ([#2072](https://github.com/elastic/eui/pull/2072))

**Bug fixes**

- Fixed proptype for `EuiCopy`'s `children` ([#2048](https://github.com/elastic/eui/pull/2048))
- Fixed `EuiInMemoryTable` to allow sorting on computed columns ([#2044](https://github.com/elastic/eui/pull/2044))
- Fixed TypeScript `Toast` member export ([#2052](https://github.com/elastic/eui/pull/2052))
- Fixed style of readOnly input groups via `EuiFormControlLayout` and `prepend`/`append` ([#2057](https://github.com/elastic/eui/pull/2057))
- Removed TS types from ES exports when the exported name differs from the imported one ([#2069](https://github.com/elastic/eui/pull/2069))
- Fixed TypeScript definitions and type exports for `EuiBadge` and `EuiCopy` ([#2052](https://github.com/elastic/eui/pull/2052))

## [`12.0.0`](https://github.com/elastic/eui/tree/v12.0.0)

- Attached `noreferrer` also to links without `target="_blank"` ([#2008](https://github.com/elastic/eui/pull/2008))
- Converted observer utility components to TypeScript ([#2009](https://github.com/elastic/eui/pull/2009))
- Converted tool tip components to TypeScript ([#2013](https://github.com/elastic/eui/pull/2013))
Expand All @@ -14,11 +125,21 @@
- Fixed `EuiFlyout` scrolling in Safari ([#2033](https://github.com/elastic/eui/pull/2033))
- Fixed `EuiCallOut` header icon alignment ([#2006](https://github.com/elastic/eui/pull/2006))
- Fixed `EuiInMemoryTable` sort value persistence through lifecycle updates ([#2035](https://github.com/elastic/eui/pull/2035))
- Fixed `EuiColorPicker` positioning and keyboard navigation in certain portal contexts ([#2038](https://github.com/elastic/eui/pull/2038))

**Breaking changes**

- Removed explicit dependency on `core-js`, but a global polyfill like `core-js@3` is still required ([#1982](https://github.com/elastic/eui/pull/1982))

## [`11.3.2`](https://github.com/elastic/eui/tree/v11.3.2)

**Note: this release is a backport containing changes originally made in `12.0.0`**

**Bug fixes**

- Fixed `EuiInMemoryTable` sort value persistence through lifecycle updates ([#2035](https://github.com/elastic/eui/pull/2035))
- Fixed `EuiColorPicker` positioning and keyboard navigation in certain portal contexts ([#2038](https://github.com/elastic/eui/pull/2038))

## [`11.3.1`](https://github.com/elastic/eui/tree/v11.3.1)

**Bug fixes**
Expand Down
22 changes: 19 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,32 @@ Here are our responses to questions we expect to get frequently.

## What is the Elastic UI Framework?

The Elastic UI Framework (EUI) is a design library in use at Elastic to build **internal products** that need to share our branding and look and feel. It distributes UI React components and static assets for use in building web layouts. Alongside the React components is a SASS/CSS layer that can be used independently on its own.
The Elastic UI Framework (EUI) is a design library in use at Elastic to build React applications that need to share our branding and aesthetics. It distributes UI React components and static assets for use in building web layouts. Alongside the React components is a SASS/CSS layer that can be used independently on its own.

## Can I use EUI?

The Elastic UI Framework is intended to only be used on Elastic products and is not supported as a discrete, independent design library. We do not recommend using it unless you are working on Elastic products or plugins to those products.
Yes, but be aware of the [license](LICENSE.md) as always. Although the roadmap and priorities are directed by our own usage within Elastic, we do attempt to make the platform generically useful for any React application and try to test for it.

## What is the versioning, releases and upgrade strategy?

We use [semver](https://semver.org/) for versioning and use that to denote breaking changes in EUI upgrades. Traditionally we consider API changes in our prop names or existing component functionality to be a reason for a breaking change, but do not track the renaming of CSS selectors, mixins or other style changes under this same rigor.

Traditionally releases are made weekly against whatever is in master and you can upgrade from NPM as you see fit.

## How do you handle Typescript, Sass and theming?

EUI started as a JS and Sass library that outputs separate CSS and JS bundles. Over time we introduced TypeScript and started adding types, writing new components in TS, and migrating old components over. The goal is to actively convert everything over into a full TS system while retaining our build targets of ES5+commonjs, ES5+ES Modules, and a consolidated bundle file.

For styling we use Sass and generate a final CSS blob for the entire library, with some JSON theming files extracted from the Sass. You can find more information in [consuming EUI](wiki/consuming) and [theming](wiki/theming.md).

## Can I contribute to EUI

Yes! We accept PRs regularly similar to our other Elastic repos.

## Why is EUI open source?

Many of our products themselves are open source and rely upon this library to function. The Elastic UI Framework began as a folder of code in Kibana and we decided it could be used beyond that codebase. It exists as an independent library so that patterns can be shared across teams and design standards can be scaled across our organization. Since most of our products are open source, we treat this one similarly as far as public publishing and conversation even if its usage tends to focus more inward towards Elastic itself.

## What about reporting bugs and feature requests?

Bug reports are most welcome, but we're not considering external feature requests at this time.
Bug reports and feature requests are most welcome, but our roadmap is driven primarily by internal usage.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
🚨 **WARNING** While open source, the intended consumers of this repository are Elastic products. Read the [FAQ][faq] for details.

# Elastic UI Framework

> The Elastic UI Framework is a collection of React UI components for quickly building user interfaces
> at Elastic. Not using React? No problem! You can still use the CSS behind each component.

You should check out our [living style guide][docs], which contains many examples on how components in the EUI framework look and feel, and how to use them in your products.
You should check out our [living style guide][docs], which contains many examples on how components in the EUI framework aesthetic, and how to use them in your products. We also have a [FAQ][faq] that covers common usage questions.

## Installation

Expand Down Expand Up @@ -49,7 +47,7 @@ yarn start

The primary goal of this library is to provide reusable UI components that can be used throughout
Elastic's web products. As React components, they remove CSS from the process of building UIs.
As a single source of truth, the framework allows our designers to make changes to our look-and-feel
As a single source of truth, the framework allows our designers to make changes to our aesthetic
directly in the code. And unit test coverage for the UI components allows us to deliver a stable
"API for user interfaces".

Expand Down
49 changes: 0 additions & 49 deletions docs/0.bundle.js

This file was deleted.

1 change: 0 additions & 1 deletion docs/0.bundle.js.map

This file was deleted.

Loading