2019-04-02 23:38:45 +02:00
|
|
|
# Deprecation notice
|
2016-12-13 02:54:56 +01:00
|
|
|
|
2019-04-02 23:38:45 +02:00
|
|
|
This package is set for deprecation and is actively being removed from Kibana.
|
2016-12-13 02:54:56 +01:00
|
|
|
|
2019-04-02 23:38:45 +02:00
|
|
|
The Kibana UI framework is a collection of React elements and Sass styles used to build legacy layouts in Kibana. It was
|
|
|
|
primarily used during the 5.x and 6.x versions and is replaced by the [Elastic UI framework](https://elastic.github.io/eui/).
|
|
|
|
Portions of Kibana still utilize this package and until it is fully removed you can still compile and view the
|
|
|
|
documentation using the instructions below.
|
2016-12-13 02:54:56 +01:00
|
|
|
|
2019-04-02 23:38:45 +02:00
|
|
|
## Compiling KUI and viewing the docs
|
2016-12-13 02:54:56 +01:00
|
|
|
|
2017-08-01 23:11:23 +02:00
|
|
|
Compile the CSS with `./node_modules/grunt/bin/grunt uiFramework:compileCss` (OS X) or
|
|
|
|
`.\node_modules\grunt\bin\grunt uiFramework:compileCss` (Windows).
|
|
|
|
|
2018-01-10 13:23:43 +01:00
|
|
|
You can view interactive documentation by running `yarn uiFramework:start` and then visiting
|
2017-09-05 10:48:42 +02:00
|
|
|
[http://localhost:8020/](http://localhost:8020/). This will also start watching the SCSS files, and will recompile the CSS
|
2017-08-01 23:11:23 +02:00
|
|
|
automatically for you when you make changes.
|
2016-12-13 02:54:56 +01:00
|
|
|
|
2017-04-12 21:15:00 +02:00
|
|
|
You can run `node scripts/jest --watch` to watch for changes and run the tests as you code.
|
2017-04-05 17:32:17 +02:00
|
|
|
|
2017-04-12 21:15:00 +02:00
|
|
|
You can run `node scripts/jest --coverage` to generate a code coverage report to see how
|
2017-04-05 17:32:17 +02:00
|
|
|
fully-tested the code is.
|
|
|
|
|
2019-04-02 23:38:45 +02:00
|
|
|
See the documentation in [`scripts/jest.js`](../scripts/jest.js) for more options.
|