Skip to content

feat: add loading api for admin app home#4441

Open
andrewiggins wants to merge 1 commit into2026-07-rcfrom
hosted-app-home-loading-api
Open

feat: add loading api for admin app home#4441
andrewiggins wants to merge 1 commit into2026-07-rcfrom
hosted-app-home-loading-api

Conversation

@andrewiggins
Copy link
Copy Markdown

@andrewiggins andrewiggins commented May 5, 2026

Background

Follow-up to https://github.com/shop/world/pull/653749, which exposes shopify.loading(isLoading?: boolean) to hosted admin.app.home.render extensions.

Similar to #4374, this updates the public admin app-home runtime types and tester mocks for the new API.

Related: shop/issues-admin-extensibility/issues/2457

Solution

  • Add a LoadingApi type for shopify.loading(isLoading?: boolean).
  • Expose loading on AppHomeApi for admin.app.home.render.
  • Export LoadingApi from the admin API barrel.
  • Update ui-extensions-tester admin app-home mocks to include shopify.loading().
  • Add tester coverage and README documentation for the app-home mock.

Validation

Use pnpm with COREPACK_ENABLE_STRICT=0 because this repo is configured for yarn and yarn is disabled on dev machines:

  • COREPACK_ENABLE_STRICT=0 pnpm run build
  • COREPACK_ENABLE_STRICT=0 pnpm run type-check
  • COREPACK_ENABLE_STRICT=0 pnpm run test packages/ui-extensions-tester/
  • COREPACK_ENABLE_STRICT=0 pnpm run lint

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 5, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@andrewiggins andrewiggins force-pushed the hosted-app-home-loading-api branch from 873abb2 to 5a57bb0 Compare May 5, 2026 22:35
@andrewiggins andrewiggins marked this pull request as ready for review May 5, 2026 22:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant