Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bump @ckeditor/ckeditor5-vue from 6.0.0 to 7.0.0 #898

Merged
merged 4 commits into from
Aug 10, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 7, 2024

Bumps @ckeditor/ckeditor5-vue from 6.0.0 to 7.0.0.

Release notes

Sourced from @​ckeditor/ckeditor5-vue's releases.

v7.0.0

We are excited to announce a new major release of the Vue integration.

In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.

  • Composition API: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3.

  • Vue 3.4+: The minimum required version of Vue is now 3.4+ because we are using the Generics and defineModel() features to provide better typings for the editor prop and component events.

  • ESM-first: Besides the UMD build, the integration is now available in ESM format. In most projects, the new ESM build should be automatically prioritized by bundlers and other tools.

  • Changed exports: We have changed how the Vue plugin and component are exported. The Vue plugin is no longer the default export but is exported as CkeditorPlugin. The component is now exported as Ckeditor instead of default.component.

    Here's a comparison of how you can import the Vue plugin that registers a global <ckeditor> component:

    // Before the release.
    import CKEditor from '@ckeditor/ckeditor5-vue';
    // After the release.
    import { CkeditorPlugin } from '@​ckeditor/ckeditor5-vue';

    If you prefer to use a local component instead of a global component, here's a comparison of how you can import it:

    // Before the release.
    import CKEditor from '@ckeditor/ckeditor5-vue';
    const component = CKEditor.component;
    // After the release.
    import { Ckeditor } from '@​ckeditor/ckeditor5-vue';
    const component = Ckeditor;

  • Remove the editor argument from the destroy event: The destroy event no longer has an editor argument since it was always null.

  • New name of the global variable: The name of the global variable used in the UMD build changed from CKEditor to CKEDITOR_VUE.

BREAKING CHANGES

  • Bump required version to Vue 3.4+. See #282.
  • Change the global name used in the UMD build from CKEditor to CKEDITOR_VUE.
  • Export the component as Ckeditor instead of default.component. Closes #284.
  • Migrate to Composition API. Closes #172.
  • Migrate to ESM. See ckeditor/ckeditor5#16616.
  • Remove argument from the destroy event, as it was always null. Closes #283.
  • Rename main package exports to CkeditorPlugin and Ckeditor.

Bug fixes

... (truncated)

Changelog

Sourced from @​ckeditor/ckeditor5-vue's changelog.

7.0.0 (2024-08-07)

We are excited to announce a new major release of the Vue integration.

In this release, we have introduced the following breaking changes that should make using the integration more intuitive and easier.

  • Composition API: The integration has been rewritten in Composition API, which follows the recommended way of writing components in Vue 3.

  • Vue 3.4+: The minimum required version of Vue is now 3.4+ because we are using the Generics and defineModel() features to provide better typings for the editor prop and component events.

  • ESM-first: Besides the UMD build, the integration is now available in ESM format. In most projects, the new ESM build should be automatically prioritized by bundlers and other tools.

  • Changed exports: We have changed how the Vue plugin and component are exported. The Vue plugin is no longer the default export but is exported as CkeditorPlugin. The component is now exported as Ckeditor instead of default.component.

    Here's a comparison of how you can import the Vue plugin that registers a global <ckeditor> component:

    // Before the release.
    import CKEditor from '@ckeditor/ckeditor5-vue';
    // After the release.
    import { CkeditorPlugin } from '@​ckeditor/ckeditor5-vue';

    If you prefer to use a local component instead of a global component, here's a comparison of how you can import it:

    // Before the release.
    import CKEditor from '@ckeditor/ckeditor5-vue';
    const component = CKEditor.component;
    // After the release.
    import { Ckeditor } from '@​ckeditor/ckeditor5-vue';
    const component = Ckeditor;

  • Remove the editor argument from the destroy event: The destroy event no longer has an editor argument since it was always null.

  • New name of the global variable: The name of the global variable used in the UMD build changed from CKEditor to CKEDITOR_VUE.

BREAKING CHANGES

  • Bump required version to Vue 3.4+. See #282.
  • Change the global name used in the UMD build from CKEditor to CKEDITOR_VUE.
  • Export the component as Ckeditor instead of default.component. Closes #284.
  • Migrate to Composition API. Closes #172.
  • Migrate to ESM. See ckeditor/ckeditor5#16616.
  • Remove argument from the destroy event, as it was always null. Closes #283.
  • Rename main package exports to CkeditorPlugin and Ckeditor.

Bug fixes

... (truncated)

Commits
  • 550fa81 Release: v7.0.0.
  • 2ee5bba Merge pull request #302 from ckeditor/release-20240807
  • 063bd83 Changelog for v7.0.0.
  • 5fc488a Docs: Changelog. [skip ci]
  • b72b20b Added missing from option for changelog script.
  • da8058c Release: v7.0.0-alpha.2.
  • cf0b5f1 Merge pull request #298 from ckeditor/release-alpha-20241707
  • dc855a3 Docs: Changelog. [skip ci]
  • eba73a5 Merge pull request #295 from ckeditor/rename-global-name
  • e2a9bbc Merge pull request #296 from ckeditor/fix-typings
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added the Type: Dependencies Dependency issues or Changes to dependency files label Aug 7, 2024
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/ckeditor/ckeditor5-vue-7.0.0 branch from 561fe3a to ab6a21b Compare August 7, 2024 21:02
@basil
Copy link
Member

basil commented Aug 10, 2024

@dependabot rebase

Bumps [@ckeditor/ckeditor5-vue](https://github.com/ckeditor/ckeditor5-vue) from 6.0.0 to 7.0.0.
- [Release notes](https://github.com/ckeditor/ckeditor5-vue/releases)
- [Changelog](https://github.com/ckeditor/ckeditor5-vue/blob/master/CHANGELOG.md)
- [Commits](ckeditor/ckeditor5-vue@v6.0.0...v7.0.0)

---
updated-dependencies:
- dependency-name: "@ckeditor/ckeditor5-vue"
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/ckeditor/ckeditor5-vue-7.0.0 branch from ab6a21b to 0c2bb25 Compare August 10, 2024 18:44
@@ -54,7 +54,6 @@

<script lang="ts">
import { FontSizeOption } from '@ckeditor/ckeditor5-font/src/fontconfig';
import { CKEditorComponentData } from '@ckeditor/ckeditor5-vue/dist/ckeditor';
Copy link
Member

@basil basil Aug 10, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in ckeditor/ckeditor5-vue#281. I tried migrating this to

diff --git a/src/components/TextBoxRich.vue b/src/components/TextBoxRich.vue
index e8b5f69..134ce32 100644
--- a/src/components/TextBoxRich.vue
+++ b/src/components/TextBoxRich.vue
@@ -54,6 +54,7 @@
 
 <script lang="ts">
 import { FontSizeOption } from '@ckeditor/ckeditor5-font/src/fontconfig';
+import { Ckeditor } from '@ckeditor/ckeditor5-vue';
 import { EditorConfig } from 'ckeditor5';
 import { StyleValue } from 'vue';
 import { Component, Prop, Vue } from 'vue-facing-decorator';
@@ -106,19 +107,19 @@ export default class TextBoxRich extends Vue {
   }
 
   get editorInstance() {
-    return (this.$refs.editor as any)?.instance;
+    return (this.$refs.editor as typeof Ckeditor)?.instance;
   }
 
   get editorInstanceLeft() {
-    return (this.$refs.editorLeft as any)?.instance;
+    return (this.$refs.editorLeft as typeof Ckeditor)?.instance;
   }
 
   get editorInstanceCenter() {
-    return (this.$refs.editorCenter as any)?.instance;
+    return (this.$refs.editorCenter as typeof Ckeditor)?.instance;
   }
 
   get editorInstanceRight() {
-    return (this.$refs.editorRight as any)?.instance;
+    return (this.$refs.editorRight as typeof Ckeditor)?.instance;
   }
 
   get content() {

but this didn't work. Not sure what I'm missing here.

@basil basil requested a review from danielgarthur August 10, 2024 19:21
@basil
Copy link
Member

basil commented Aug 10, 2024

I found the solution buried in vuejs/language-tools#3206 and vuejs/core#4397. Now pardon me while I go back to Java development…

@basil basil merged commit a37f48d into master Aug 10, 2024
3 checks passed
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/ckeditor/ckeditor5-vue-7.0.0 branch August 10, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Dependencies Dependency issues or Changes to dependency files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant