gradio/js
Yuichiro Tachibana (Tsuchiya) 9919b8ab43
Fix the docstring decoration (#5885)
* Fix the docstring of the `Slider` class

* add changeset

* Update the JSON file generator to output a new field .styled_description to render the inline code syntax in the description field

* add changeset

* Update style_types() to deal with backticks and single asterisks

* Update the inline style converter to use regex for the curly bracket syntax as well

* Revert `style_types()` not to touch the `description` field and update the frontend code to apply styling to such formatted texts on Svelte's side

* Apply the inline styler to other `.description` field appearances

* Apply the inline styler to `.preprocessing`, `.postprocessing`, `.examples-format`, `.events`, and `*.parameters.doc`

* Stop applying HTML styles to the JSON data, instaed apply HTML escaping

* Escape HTML tokens in .parameters[]["doc"] too

* fixes

---------

Co-authored-by: gradio-pr-bot <gradio-pr-bot@users.noreply.github.com>
Co-authored-by: Ali Abdalla <ali.si3luwa@gmail.com>
2023-11-28 06:03:20 -05:00
..
_cdn-test chore(deps): update all non-major dependencies (#6537) 2023-11-22 18:04:27 -05:00
_spaces-test Version 4 development branch (#5498) 2023-10-31 04:46:02 +00:00
_website Fix the docstring decoration (#5885) 2023-11-28 06:03:20 -05:00
accordion chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
annotatedimage chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
app Make FileExplorer work on python 3.8 and 3.9. Also make it update on changes to root, glob, or glob_dir (#6550) 2023-11-28 05:27:45 -05:00
atoms chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
audio chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
box chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
button chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
chatbot Improve like/dislike functionality (#6572) 2023-11-24 19:03:18 +01:00
checkbox chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
checkboxgroup chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
code chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
colorpicker chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
column chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
dataframe chore: update versions (#6554) 2023-11-22 22:11:41 -05:00
dataset chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
dropdown chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
fallback chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
file chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
fileexplorer Make FileExplorer work on python 3.8 and 3.9. Also make it update on changes to root, glob, or glob_dir (#6550) 2023-11-28 05:27:45 -05:00
form chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
gallery chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
group chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
highlightedtext chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
html chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
icons Improve like/dislike functionality (#6572) 2023-11-24 19:03:18 +01:00
image chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
imageeditor chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
json chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
label chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
lite chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
markdown chore: update versions (#6554) 2023-11-22 22:11:41 -05:00
model3D chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
number chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
plot chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
preview chore: update versions (#6554) 2023-11-22 22:11:41 -05:00
radio chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
row chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
simpledropdown chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
simpletextbox chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
slider chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
state chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
statustracker chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
storybook chore: update versions (#6420) 2023-11-16 19:54:38 -08:00
tabitem chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
tabs chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
textbox chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
theme chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
tooltip chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
tootils chore: update versions (#6481) 2023-11-20 13:45:52 -08:00
upload chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
uploadbutton Feat: make UploadButton accept icon (#6584) 2023-11-27 09:31:21 +00:00
utils chore: update versions (#6039) 2023-10-31 13:20:18 +00:00
video chore: update versions (#6514) 2023-11-22 18:43:10 -05:00
wasm chore: update versions (#6381) 2023-11-13 19:19:34 -08:00
.npmrc move files (#3605) 2023-03-27 16:12:58 -07:00
jsx.d.ts update deps + fix tests (#4675) 2023-06-28 22:40:53 +01:00
README.md Updated CI info in contributing docs (#4415) 2023-06-06 08:52:29 -04:00

gradio-ui

This folder contains all of the Gradio UI and component source code.

setup

This folder is managed as 'monorepo' a multi-package repository which make dependency management very simple. In order to do this we use pnpm as our package manager.

Make sure pnpm is installed by following the installation instructions for your system.

You will also need node which you probably already have

running the application

Install all dependencies:

pnpm i

This will install the dependencies for all packages and link any local packages

local development

To develop locally, open two terminal tabs from the root of the repository.

Run the python test server, from the root directory:

cd demo/kitchen_sink
python run.py

This will start a development server on port 7860 that the web app is expecting.

Run the web app:

pnpm dev

building for production

Run the build:

pnpm build

This will create the necessary files in js/app/public and also in gradio/templates/frontend.

quality checks

The repos currently has two quality checks that can be run locally and are run in CI.

formatting

Formatting is handled by prettier to ensure consistent formatting and prevent style-focused conversations. Formatting failures will fails CI and should be reoslve before merging.

To check formatting:

pnpm format:check

If you have formatting failures then you can run the following command to fix them:

pnpm format:write

type checking

We use TypeScript to provide static types to javascript code. These checks are also run in CI.

to typecheck the code:

pnpm ts:check

ci checks

Currently the following checks are run in CI:

static checks

  • Format check (pnpm format:check)
  • Build css (pnpm css)
  • Build client (pnpm build)
  • Type check (pnpm ts:check)
  • Unit tests (pnpm test:run)

functional test

pip install -r demo/outbreak_forecast/requirements.txt
pnpm exec playwright install chromium
pnpm exec playwright install-deps chromium
pnpm test:browser:full