mirror of https://github.com/react/react-native-devtools-frontend.git synced 2026-09-28 13:13:37 +08:00

Files

T

Jack Franklin 49e33f9fa2 Remove component docs server image path hack

This hack was needed back when we didn't unify how we loaded images in
CSS; we now do via the `var(--image-file-X)` approach that generates
correct relative images. Therefore we can lose this hack in the
component docs :)

Bug: none
Change-Id: I98ec7d21437aa280d7a33ecd4fae64f59bfba83b
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/2794950
Commit-Queue: Jack Franklin <jacktfranklin@chromium.org>
Commit-Queue: Tim van der Lippe <tvanderlippe@chromium.org>
Auto-Submit: Jack Franklin <jacktfranklin@chromium.org>
Reviewed-by: Tim van der Lippe <tvanderlippe@chromium.org>

2021-03-31 11:03:13 +00:00

BUILD.gn

Add test-suite-source-dir flag to new test runner

2021-03-18 11:19:17 +00:00

README.md

Workflow improvements to component docs

2021-01-08 16:55:37 +00:00

server.js

Remove component docs server image path hack

2021-03-31 11:03:13 +00:00

README.md

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/DIR where DIR is the name of your component.
Within the new DIR, add HTML and TypeScript files. Each one of these is a standalone example. You should name the HTML file based on what it's documenting, e.g. basic.html or data-missing.html, and add a TypeScript file with the same name. The TypeScript file should contain all the code to import and run your component, and within the HTML file you can place any HTML or CSS you need (inline style tags are fine for examples) to render the component in the right context.
Create a BUILD.gn in your new DIR. This should contain the following code:

import("../../../scripts/build/ninja/copy.gni")
import("../../../third_party/typescript/typescript.gni")

ts_library("ts") {
  sources = [
    "basic.ts"
  ]

  deps = [
    # As an example: anything your TS code imports needs to be listed here as a dep.
    "../../ui/components:bundle",
  ]
}

copy_to_gen("elements_breadcrumbs") {
  sources = [
    "basic.html",
    # list all other examples here
  ]

  deps = [
    ":ts"
  ]
}

Update front_end/component_docs/BUILD.gn to add your new directory's BUILD.GN to the public_deps array.
Run npm run components-server to fire up a server on localhost: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 --target flag: npm run components-server -- --target=Release.