refactor(NcModal): migrate to Typescript and script-setup + feat(useHotKey): add new option `allowInModal` by susnux · Pull Request #7514 · nextcloud-libraries/nextcloud-vue

susnux · 2025-09-15T09:01:25Z

☑️ Resolves

Large part of [FR]: TypeScript support #841

This consists of multiple refactoring as you can review individually with each commit.
Basically this migrates the component to Typescript and then to script-setup with new consistent tag order.
By doing so also removed the last JS util (Timer) and just uses the useIntervalFn from vueuse.

🏁 Checklist

⛑️ Tests are included or are not applicable
📘 Component documentation has been extended, updated or is not applicable
2️⃣ Backport to stable8 for maintained Vue 2 version or not applicable

susnux · 2025-11-07T17:11:39Z

(just a rebase for CI)

codecov · 2025-11-07T17:13:33Z

Codecov Report

❌ Patch coverage is 50.00000% with 52 lines in your changes missing coverage. Please review.
✅ Project coverage is 52.96%. Comparing base (e69604f) to head (0bdf7ec).
⚠️ Report is 13 commits behind head on main.

Files with missing lines	Patch %	Lines
src/components/NcModal/NcModal.vue	48.00%	39 Missing and 13 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7514      +/-   ##
==========================================
+ Coverage   52.20%   52.96%   +0.76%     
==========================================
  Files         101      100       -1     
  Lines        3174     3119      -55     
  Branches      871      868       -3     
==========================================
- Hits         1657     1652       -5     
+ Misses       1271     1229      -42     
+ Partials      246      238       -8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

ShGKme · 2025-11-12T21:09:12Z

I'll check on the morning

ShGKme

Nitpicks only.

Thanks for splitting into commits.

src/components/NcModal/NcModal.vue

Antreesy

Otherwise nice work!

src/components/NcModal/NcModal.vue

susnux · 2025-11-25T19:38:34Z

Added commits fixing the review comments

Antreesy

Otherwise fine. Maybe we'll keep native eventListeners for now?

src/components/NcModal/NcModal.vue

susnux · 2025-11-26T13:14:35Z

@ShGKme @Antreesy please check the new commit (latest)

- Use Typescript for component - Use vueuse composable instead of custom Timer class Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Instead of dialog example where we recommend to use NcDialog we should provide an example on how to use the slideshow feature. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

1. Script 2. Template 3. Styles 4. Docs Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

This allows to also trigger hotkeys in modals. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

susnux · 2025-11-28T10:26:50Z

(rebased to check CI)

susnux added this to the 9.0.0 milestone Sep 15, 2025

susnux added 3. to review Waiting for reviews feature: modal Related to the modal component refactor ♻️ Pull request that is neither a fix nor a feature labels Sep 15, 2025

susnux force-pushed the refactor/nc-modal-ts branch from a488070 to 09e25d7 Compare September 15, 2025 09:09

susnux requested review from Antreesy, artonge and st3iny September 15, 2025 09:09

susnux force-pushed the refactor/nc-modal-ts branch from 09e25d7 to 8ad5ebb Compare September 15, 2025 09:20

Antreesy modified the milestones: 9.0.0, 9.0.1 Oct 1, 2025

susnux modified the milestones: 9.0.1, 9.0.2 Oct 6, 2025

susnux modified the milestones: 9.0.2, 9.1.0 Oct 14, 2025

susnux removed the request for review from st3iny November 4, 2025 11:31

susnux modified the milestones: 9.1.0, 9.2.0 Nov 4, 2025

susnux force-pushed the refactor/nc-modal-ts branch from 8ad5ebb to d4641da Compare November 7, 2025 17:11

susnux requested a review from ShGKme November 12, 2025 20:38

ShGKme modified the milestones: 9.2.0, 9.3.0 Nov 14, 2025

ShGKme approved these changes Nov 16, 2025

View reviewed changes

susnux modified the milestones: 9.3.0, 9.3.1 Nov 20, 2025

ShGKme mentioned this pull request Nov 25, 2025

fix(settings): Check devices cannot be open from the main menu settings nextcloud/talk-desktop#1560

Merged

Antreesy reviewed Nov 25, 2025

View reviewed changes

src/components/NcModal/NcModal.vue Outdated Show resolved Hide resolved

src/components/NcModal/NcModal.vue Outdated Show resolved Hide resolved

src/components/NcModal/NcModal.vue Outdated Show resolved Hide resolved

src/components/NcModal/NcModal.vue Show resolved Hide resolved

susnux commented Nov 25, 2025

View reviewed changes

src/components/NcModal/NcModal.vue Outdated Show resolved Hide resolved

susnux force-pushed the refactor/nc-modal-ts branch 2 times, most recently from 591f6ca to eb2e092 Compare November 25, 2025 19:38

susnux force-pushed the refactor/nc-modal-ts branch from eb2e092 to 86ad6b0 Compare November 25, 2025 22:38

susnux requested a review from Antreesy November 25, 2025 22:39

Antreesy approved these changes Nov 26, 2025

View reviewed changes

src/components/NcModal/NcModal.vue Show resolved Hide resolved

Antreesy approved these changes Nov 26, 2025

View reviewed changes

susnux added 12 commits November 28, 2025 11:23

refactor(NcModal): migrate to Typescript

bf0ed28

- Use Typescript for component - Use vueuse composable instead of custom Timer class Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

docs(NcModal): add proper example for slideshow feature

96b101a

Instead of dialog example where we recommend to use NcDialog we should provide an example on how to use the slideshow feature. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

refactor(NcModal): consistently use @mdi/js

1d306cb

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

refactor(NcModal): migrate to script setup

7464229

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

refactor(NcModal): use Typescript for props and emit definition

0307bb9

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

refactor(NcModal): use consistent tag order with script-setup

30b90f2

1. Script 2. Template 3. Styles 4. Docs Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

fix: use correct logic for RTL handling

db345de

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

chore: apply some Typescript improvements

3a476e9

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

chore(NcModal): use model instead of props for show state

2bb5d8f

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

refactor(NcModal): manually pass attrs to dialog

d4ca9a3

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

docs(NcModal): adjust examples

aad0e6d

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

feat(useHotKey): add new option allowInModal

0bdf7ec

This allows to also trigger hotkeys in modals. Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

susnux force-pushed the refactor/nc-modal-ts branch from e59f163 to 0bdf7ec Compare November 28, 2025 10:26

susnux merged commit 3f02ce0 into main Nov 28, 2025
26 of 27 checks passed

susnux deleted the refactor/nc-modal-ts branch November 28, 2025 10:42

ShGKme changed the title ~~refactor(NcModal): migrate to Typescript and script-setup~~ refactor(NcModal): migrate to Typescript and script-setup + feat(useHotKey): add new option allowInModal Nov 28, 2025

ShGKme added the enhancement New feature or request label Nov 28, 2025

ShGKme mentioned this pull request Dec 1, 2025

fix(NcModal): scoped styles with teleport #7941

Merged

3 tasks

skjnldsv mentioned this pull request Dec 10, 2025

chore: v9.3.1 #7973

Merged

Conversation

susnux commented Sep 15, 2025

☑️ Resolves

🏁 Checklist

Uh oh!

susnux commented Nov 7, 2025

Uh oh!

codecov bot commented Nov 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

ShGKme commented Nov 12, 2025

Uh oh!

ShGKme left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Antreesy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

susnux commented Nov 25, 2025

Uh oh!

Antreesy left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

susnux commented Nov 26, 2025

Uh oh!

susnux commented Nov 28, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Nov 7, 2025 •

edited

Loading