Adds the easy parts of the inline values list: a list of chips that shows you which values you have and that you can delete. You either delete them by clicking the "clear" icon or by using del/backspace on your keyboard. If you use your keyboard we also handle switching your focus to the appropriate element. By default, your browser may shift the focus to the top of the window (which isn't very helpful). Instead, we handle it like this: - If you delete an item and there are more elements in the list: - move the element to the next item if exists - if your element is the last item, move focus to the previous item - if there are no more items in the list, move the focus to the Add Values button We still need to add the "add values" popover functionality. That's next on the agenda. Additionally, this switches how the containing flex container positions its items along the cross axis (vertically) to "flex-start" instead of "center". Because the values list can grow to multiple lines, it would shift the "delete constraint" button and the constraint picker to the middle of the expanded constraint. Now, instead they stay aligned to the top. This causes a slight alignment issue with the button (due to the invisible padding), but I don't want to look at that before the rest of this is complete and we know how it all fits together. You'll notice that the spacing between elements in that top row is also off anyway (look at the value list being smushed up against the case sensitive icon), so there's more work to do. <img width="716" alt="image" src="https://github.com/user-attachments/assets/225fcab8-03e4-46e3-92d4-82912eb40d46" /> Focus styles: <img width="190" alt="image" src="https://github.com/user-attachments/assets/6b07ab25-0a67-493c-9cac-839932b0d654" /> <img width="195" alt="image" src="https://github.com/user-attachments/assets/9d5b323e-bf65-4eca-9008-a45ce0139a2b" /> Hover styles: <img width="96" alt="image" src="https://github.com/user-attachments/assets/f19e1945-d2be-4e87-8005-76cb6beb1f50" /> |
||
---|---|---|
.. | ||
.yarn/releases | ||
cypress | ||
public | ||
scripts | ||
src | ||
.editorconfig | ||
.gitignore | ||
.npmignore | ||
.nvmrc | ||
.yarnrc.yml | ||
check-imports.rc | ||
cypress.config.ts | ||
cypress.d.ts | ||
index.html | ||
index.js | ||
orval.config.js | ||
package.json | ||
README.md | ||
tsconfig.json | ||
tsconfig.node.json | ||
vercel.json | ||
vite.config.mts | ||
yarn.lock |
frontend
This directory contains the Unleash Admin UI frontend app.
Run with a local instance of the unleash-api
Refer to the Contributing to Unleash guide for instructions. The frontend dev server runs (in port 3000) simultaneously with the backend dev server (in port 4242):
yarn install
yarn dev
Run with a sandbox instance of the Unleash API
Alternatively, instead of running unleash-api on localhost, you can use a remote instance:
cd ./frontend
yarn install
yarn run start:sandbox
Running end-to-end tests
We have a set of Cypress tests that run on the build before a PR can be merged so it's important that you check these yourself before submitting a PR. On the server the tests will run against the deployed Heroku app so this is what you probably want to test against:
yarn run start:sandbox
In a different shell, you can run the tests themselves:
yarn run e2e:heroku
If you need to test against patches against a local server instance, you'll need to run that, and then run the end to end tests using:
yarn run e2e
You may also need to test that a feature works against the enterprise version of unleash. Assuming the Heroku instance is still running, this can be done by:
yarn run start:enterprise
yarn run e2e
Generating the OpenAPI client
The frontend uses an OpenAPI client generated from the backend's OpenAPI spec. Whenever there are changes to the backend API, the client should be regenerated:
For now we only use generated types (src/openapi/models). We will use methods (src/openapi/apis) for new features soon.
yarn gen:api
rm -rf src/openapi/apis
clean up src/openapi/index.ts
imports, only keep first line export * from './models';
This script assumes that you have a running instance of the enterprise backend at http://localhost:4242
.
The new OpenAPI client will be generated from the runtime schema of this instance.
The target URL can be changed by setting the UNLEASH_OPENAPI_URL
env var.
Analyzing bundle size
npx vite-bundle-visualizer
in the root of the frontend directory