mirror of https://github.com/react/react-native-devtools-frontend.git synced 2026-09-30 17:27:22 +08:00

Files

T

Andrés Olivares f1d811c86e Add ui/legacy/tokens.css to component server

This way we ensure colors loaded from this file are available in the
component examples and screenshot tests, since it seems that after
https://crrev.com/c/4650363 , some colors for icons were no longer
available in the component server (see screenshots updates).

This CL adds the missing stylesheet to the server and adds it to a
reusable array so that stylesheet paths don't have to be hardcoded
multiple times.

Note: I forced a screenshot update so many goldens that are unrelated
to this issue are also re-baselined.

Bug: none
Change-Id: I8adcfbdd4966706a9b6f15d0947b4ef0ac0e96f4
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/4678757
Reviewed-by: Jack Franklin <jacktfranklin@chromium.org>
Reviewed-by: Kateryna Prokopenko <kprokopenko@chromium.org>
Commit-Queue: Andres Olivares <andoli@chromium.org>

2023-07-13 11:07:48 +00:00

BUILD.gn

Remove resources from ui/legacy/module.json

2021-11-16 16:47:21 +00:00

README.md

Move component_docs to ui/components/docs

2021-04-14 15:08:31 +00:00

server.js

Add ui/legacy/tokens.css to component server

2023-07-13 11:07:48 +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/ui/components/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/data_grid:bundle",
  ]
}

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

  deps = [
    ":ts"
  ]
}

Update front_end/ui/components/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.