Ghost/apps/admin-x-settings
Jono M 48b90e4253
Improved modal save handling in Admin X (#18794)
refs https://github.com/TryGhost/Product/issues/4060

---

<!-- Leave the line below if you'd like GitHub Copilot to generate a
summary from your commit -->
<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at 55149bc</samp>

Refactored various settings forms and modals in the admin app to use the
updated `useForm` hook, which simplifies the form state management,
validation, and saving logic. Improved the UI and UX of the modal ok
buttons by using the `okProps` object and the `saveState` from the hook.
Added options to save the forms without changes and to fake the saving
when unchanged. Fixed some bugs and removed unused code.
2023-10-30 17:57:19 +00:00
..
.storybook AdminX storybook updates (#18503) 2023-10-09 17:04:01 +02:00
src Improved modal save handling in Admin X (#18794) 2023-10-30 17:57:19 +00:00
test AdminX Settings UX improvements (#18741) 2023-10-25 16:37:58 +02:00
.eslintrc.cjs Temporarily fixed eslint rules being disabled in AdminX (#17565) 2023-08-02 08:37:51 +01:00
.yarnrc Prevented git tags from being created for apps 2023-07-10 13:09:28 +02:00
index.html Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
node-shim.cjs Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00
package.json Updated timezone-data and color-utils to use built in type definitions (#18795) 2023-10-30 16:40:54 +00:00
playwright.config.ts Renamed e2e tests to acceptance tests in Admin X (#18439) 2023-10-03 16:20:40 +07:00
postcss.config.cjs Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
README.md Updated Admin-X settings readme (#18721) 2023-10-23 10:22:03 +07:00
tailwind.config.cjs AdminX Settings UX improvements (#18741) 2023-10-25 16:37:58 +02:00
tsconfig.json Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
tsconfig.node.json Moved Admin-X-Settings to apps/ folder 2023-06-23 14:37:39 +02:00
vite.config.ts Port custom theme setting visibility to admin-x (#18367) 2023-10-02 15:54:14 +01:00

Admin X Settings

Ghost Admin Settings in React

Development

Pre-requisites

  • Run yarn in Ghost monorepo root

Running the development version

Run yarn dev to start the development server to test/develop the settings standalone. This will generate a demo site from the index.html file which renders the app and makes it available on http://localhost:5173

Running inside Admin

Run yarn dev (like you would run Ghost dev normally) from the top-level repo. AdminX will automatically rebuild when you make changes.

Develop

This is a monorepo package.

Follow the instructions for the top-level repo.

  1. git clone this repo & cd into it as usual
  2. Run yarn to install top-level dependencies.

Test

  • yarn lint run just eslint
  • yarn test:acceptance runs acceptance tests
  • yarn test:unit runs unit tests
  • yarn test:acceptance path/to/test runs a specific test
  • yarn test:acceptance:slowmo runs acceptance tests in slow motion and headed mode, useful for debugging and developing tests