-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
24 changed files
with
909 additions
and
147 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,10 +5,10 @@ | |
| <modelVersion>4.0.0</modelVersion> | ||
|
|
||
| <groupId>com.flowingcode.vaadin.addons</groupId> | ||
| <artifactId>template-addon</artifactId> | ||
| <artifactId>markdown-editor-addon</artifactId> | ||
| <version>1.0.0-SNAPSHOT</version> | ||
| <name>Template Add-on</name> | ||
| <description>Template Add-on for Vaadin Flow</description> | ||
| <name>Markdown Editor Add-on</name> | ||
| <description>Markdown Editor for Vaadin Flow</description> | ||
| <url>https://www.flowingcode.com/en/open-source/</url> | ||
|
|
||
| <properties> | ||
|
|
@@ -39,9 +39,9 @@ | |
| </licenses> | ||
|
|
||
| <scm> | ||
| <url>https://github.com/FlowingCode/AddonStarter24</url> | ||
| <connection>scm:git:git://github.com/FlowingCode/AddonStarter24.git</connection> | ||
| <developerConnection>scm:git:ssh://[email protected]:/FlowingCode/AddonStarter24.git</developerConnection> | ||
| <url>https://github.com/FlowingCode/MarkdownEditor</url> | ||
| <connection>scm:git:git://github.com/FlowingCode/MarkdownEditor.git</connection> | ||
| <developerConnection>scm:git:ssh://[email protected]:/FlowingCode/MarkdownEditor.git</developerConnection> | ||
| <tag>master</tag> | ||
| </scm> | ||
|
|
||
|
|
@@ -126,6 +126,7 @@ | |
| <groupId>com.flowingcode.vaadin.addons.demo</groupId> | ||
| <artifactId>commons-demo</artifactId> | ||
| <version>${flowingcode.commons.demo.version}</version> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.slf4j</groupId> | ||
|
|
@@ -226,8 +227,14 @@ | |
| <licenseName>apache_v2</licenseName> | ||
| <addJavaLicenseAfterPackage>false</addJavaLicenseAfterPackage> | ||
| <excludes> | ||
| <exclude>**/dev-bundle/**</exclude> | ||
| <exclude>**/main/dev-bundle/**</exclude> | ||
| <exclude>**/main/bundles/**</exclude> | ||
| <exclude>**/main/frontend/**</exclude> | ||
| <exclude>**/main/frontend/**</exclude> | ||
| </excludes> | ||
| <extraExtensions> | ||
| <tsx>java</tsx> | ||
| </extraExtensions> | ||
| </configuration> | ||
| </plugin> | ||
| <plugin> | ||
|
|
@@ -306,7 +313,10 @@ | |
| <configuration> | ||
| <quiet>true</quiet> | ||
| <doclint>none</doclint> | ||
| <additionalparam>-Xdoclint:none</additionalparam> | ||
| <failOnWarnings>true</failOnWarnings> | ||
| <links> | ||
| <link>https://javadoc.io/doc/com.vaadin/vaadin-platform-javadoc/${vaadin.version}</link> | ||
| </links> | ||
| </configuration> | ||
| </plugin> | ||
| <plugin> | ||
|
|
||
96 changes: 96 additions & 0 deletions
96
src/main/java/com/flowingcode/vaadin/addons/markdown/BaseMarkdownComponent.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| /*- | ||
| * #%L | ||
| * Markdown Editor Add-on | ||
| * %% | ||
| * Copyright (C) 2024 Flowing Code | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
| package com.flowingcode.vaadin.addons.markdown; | ||
|
|
||
| import com.vaadin.flow.component.HasSize; | ||
| import com.vaadin.flow.component.dependency.CssImport; | ||
| import com.vaadin.flow.component.dependency.NpmPackage; | ||
| import com.vaadin.flow.component.react.ReactAdapterComponent; | ||
|
|
||
| /** | ||
| * Base class for Markdown based Components. | ||
| */ | ||
| @SuppressWarnings("serial") | ||
| @CssImport("./styles/markdown-editor-styles.css") | ||
| @NpmPackage(value = "mermaid", version = "11.2.1") | ||
| @NpmPackage(value = "@uiw/react-md-editor", version = "4.0.4") | ||
| @NpmPackage(value = "dompurify", version = "3.1.6") | ||
| public class BaseMarkdownComponent extends ReactAdapterComponent implements HasSize { | ||
|
|
||
| /** | ||
| * Defines the color schemes for the Markdown component. | ||
| * | ||
| * The color mode can be set using the {@link #setDataColorMode(DataColorMode)} method. | ||
| * | ||
| * <ul> | ||
| * <li>{@link #DARK}: Dark color scheme. | ||
| * <li>{@link #LIGTH}: Light color scheme. | ||
| * <li>{@link #AUTO}: Automatically detects the color scheme based on the user's system settings. | ||
| * </ul> | ||
| */ | ||
| public enum DataColorMode {DARK,LIGTH,AUTO}; | ||
|
|
||
| /** | ||
| * Base constructor that receives the content of the markdown component. | ||
| * | ||
| * @param content content to be used in the Markdown component | ||
| */ | ||
| public BaseMarkdownComponent(String content) { | ||
| setContent(content); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the content of the Markdown component. | ||
| * | ||
| * @return the content of the Markdown component | ||
| */ | ||
| public String getContent() { | ||
| return getState("content", String.class); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the content of the Markdown component. | ||
| * | ||
| * @param content retrieved from the state of the component | ||
| */ | ||
| public void setContent(String content) { | ||
| setState("content", content); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the color mode of the Markdown component. | ||
| * | ||
| * @param mode the color mode of the component | ||
| */ | ||
| public void setDataColorMode(DataColorMode mode) { | ||
| switch (mode) { | ||
| case DARK: | ||
| getElement().setAttribute("data-color-mode", "dark"); | ||
| break; | ||
| case LIGTH: | ||
| getElement().setAttribute("data-color-mode", "light"); | ||
| break; | ||
| case AUTO: | ||
| getElement().removeAttribute("data-color-mode"); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| } |
88 changes: 88 additions & 0 deletions
88
src/main/java/com/flowingcode/vaadin/addons/markdown/MarkdownEditor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /*- | ||
| * #%L | ||
| * Markdown Editor Add-on | ||
| * %% | ||
| * Copyright (C) 2024 Flowing Code | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package com.flowingcode.vaadin.addons.markdown; | ||
|
|
||
| import com.vaadin.flow.component.Tag; | ||
| import com.vaadin.flow.component.dependency.JsModule; | ||
| import com.vaadin.flow.component.dependency.NpmPackage; | ||
|
|
||
| /** | ||
| * Markdown component that allows editing the contents. | ||
| */ | ||
| @SuppressWarnings("serial") | ||
| @NpmPackage(value = "rehype-sanitize", version = "6.0.0") | ||
| @JsModule("./markdown-editor.tsx") | ||
| @Tag("markdown-editor") | ||
| public class MarkdownEditor extends BaseMarkdownComponent { | ||
|
|
||
| /** | ||
| * Constructor with empty content. | ||
| */ | ||
| public MarkdownEditor() { | ||
| super(null); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor with default content. | ||
| * | ||
| * @param content default content for the Markdown editor | ||
| */ | ||
| public MarkdownEditor(String content) { | ||
| super(content); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the placeholder text for the Markdown editor. | ||
| * | ||
| * @return the placeholder text | ||
| */ | ||
| public String getPlaceholder() { | ||
| return getState("placeholder", String.class); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the placeholder text for the Markdown editor. | ||
| * | ||
| * @param placeholder the placeholder text | ||
| */ | ||
| public void setPlaceholder(String placeholder) { | ||
| setState("placeholder", placeholder); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the configured maximum character count for the Markdown editor. | ||
| * | ||
| * @return the configured maximum character count | ||
| */ | ||
| public int getMaxLength() { | ||
| return getState("maxLength", Integer.class); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the maximum character count for the Markdown editor. | ||
| * | ||
| * @param maxlength the maximum character count | ||
| */ | ||
| public void setMaxLength(int maxlength) { | ||
| setState("maxLength", maxlength); | ||
| } | ||
|
|
||
| } |
52 changes: 52 additions & 0 deletions
52
src/main/java/com/flowingcode/vaadin/addons/markdown/MarkdownViewer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| /*- | ||
| * #%L | ||
| * Markdown Editor Add-on | ||
| * %% | ||
| * Copyright (C) 2024 Flowing Code | ||
| * %% | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * #L% | ||
| */ | ||
|
|
||
| package com.flowingcode.vaadin.addons.markdown; | ||
|
|
||
| import com.vaadin.flow.component.Tag; | ||
| import com.vaadin.flow.component.dependency.JsModule; | ||
| import com.vaadin.flow.component.dependency.NpmPackage; | ||
| import com.vaadin.flow.component.react.ReactAdapterComponent; | ||
|
|
||
| /** | ||
| * Component for displaying Markdown text | ||
| */ | ||
| @SuppressWarnings("serial") | ||
| @JsModule("./markdown-viewer.tsx") | ||
| @Tag("markdown-viewer") | ||
| public class MarkdownViewer extends BaseMarkdownComponent { | ||
|
|
||
| /** | ||
| * Constructor with empty content. | ||
| */ | ||
| public MarkdownViewer() { | ||
| super(""); | ||
| } | ||
|
|
||
| /** | ||
| * Constructor that receives the default content. | ||
| * | ||
| * @param content default content for the Markdown Viewer | ||
| */ | ||
| public MarkdownViewer(String content) { | ||
| super(content); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.