mirror of
https://github.com/react/react-native-devtools-frontend.git
synced 2026-10-01 17:57:36 +08:00
This also helps future work, for example, Computed style grouping, to be TS-componentized as well. Bug: chromium:1106251, chromium:1096230 Change-Id: I2f8a977f4e3f701905354cb4edb15702cb8cd2a3 Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/2336723 Commit-Queue: Changhao Han <changhaohan@chromium.org> Reviewed-by: Paul Lewis <aerotwist@chromium.org> Reviewed-by: Jack Franklin <jacktfranklin@chromium.org> Reviewed-by: Mathias Bynens <mathias@chromium.org> Reviewed-by: Alex Rudenko <alexrudenko@chromium.org>
Components dev server
This server serves up examples of the web components built within DevTools and provides a useful way to document various states of components.
For more background, see the initial proposal and design doc.
To add an example for your component:
- Create
front_end/component_docs/DIRwhereDIRis the name of your component. - Within the new
DIR, add HTML files. Each one of these is a standalone example. You should name the HTML file based on what it's documenting, e.g.basic.htmlordata-missing.html. This file should import your component and render it with the data you need. - Create a
BUILD.gnin your newDIR. This should contain the following code:
import("../../../scripts/build/ninja/copy.gni")
copy_to_gen("elements_breadcrumbs") {
sources = [
"example1.html",
# list all other examples here
]
deps = [
# Any dependencies your examples rely on.
# For example, if they depend on code in the elements module:
"../../elements"
]
}
- Update
front_end/component_docs/BUILD.gnto add your new directory'sBUILD.GNto thepublic_depsarray. - Run
npm run components-serverto fire up a server onlocalhost:8090. You should now see your component listed and you can click on the link to view the examples. - Note: the server assumes your built target is
Default. If not, run the server and pass the--targetflag:npm run components-server -- --target=Release.