Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@zendeskgarden/ckeditor

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@zendeskgarden/ckeditor

Garden editor implementation for CKEditor5

1.0.0
latest
Source
npm

Version published: 2 weeks ago

Maintainers: 1

Created: 4 years ago

Source

Garden RTE Resources

:seedling: Garden is the design system by Zendesk

This package provides Garden theme customizations for the @ckeditor/ckeditor5-theme-lark package.

Installation

npm install --save-dev @zendeskgarden/ckeditor

Usage

When building editors from source, ensure that any webpack configurations also include the Garden package.

{
  test: [/ckeditor5-[^/\\]+[/\\]theme[/\\].+\.css$/, /zendeskgarden[\/\\]ckeditor[\/\\].+[\/\\]theme[\/\\].+\.css$/],
  use: [
      {
        loader: 'style-loader'
      },
      {
        loader: 'postcss-loader',
        options: styles.getPostCssConfig( {
            themeImporter: {
                themePath: require.resolve('@ckeditor/ckeditor5-theme-lark')
            }
        })
      },
  ]
}

Then include the theme overrides in your application.

import '@zendeskgarden/ckeditor';

Dark mode

Apply the data-ck-color-scheme="dark" attribute to an element (i.e. <body>) that wraps all of CKEditor's rendered components. This includes the editor itself, the toolbar, and the .ck-body-wrapper that contains floating elements (tooltips, modals, etc.).

Contribution

Thanks for your interest in Garden! Community involvement helps make our design system fresh and tasty for everyone.

Got issues with what you find here? Please feel free to create an issue.

Community behavior is benevolently ruled by a code of conduct. Please participate accordingly.

License

Licensed under the Apache License, Version 2.0

Some of the code included in this Zendesk repo may depend upon software authored and provided by CKSource Frederico Knabben. The terms and conditions of the Apache license do not extend to software provided by CKSource, which may be provided under different licenses. Please see the CKEditor Software License Agreement for additional information.

1.0.0 (2024-11-07)

⚠ BREAKING CHANGES

items include...

removal of individual _component.css files from the dist (the overrides are expected to be used as a collective starting point for RTE styling)
overall cleanup affects various CSS selector specificity
resets for CKEditor's generally outdated focus management (predicated on adding/removing element classes) in favor of modernized :focus-visible styling

Includes updated styling for the following RTE components:

blockquote
button
code
code block
horizontal rule
input
link
list
menu
modal (balloon-panel)
tooltip
typearound
typography (paragraph, h2, h3, h4, h5, strong, u)

See README for dark mode usage.

Features

restyle based on Garden v9 with dark mode included (#157) (8fad501)

Keywords

FAQs

What is @zendeskgarden/ckeditor?

Is @zendeskgarden/ckeditor well maintained?

Package last updated on 07 Nov 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install