Enhancement: New Field Recommendation: Jodit Editor

[hasansezertasan]

Jodit Editor: Open Source WYSIWYG editor written in pure TypeScript

It has CDN support and is initialized by a single line of JavaScript.

I'm planning to implement a field that uses Jodit Editor. I have a lot more fields in mind.

Should I implement it and open a PR?

[hasansezertasan]

@jowilf As I said, I have a lot more fields in mind, so you might think that creating a third-party package (something called 'starlette-admin-fields') is a better idea. If that is the case would you mention and reference this hypothetical package in the documentation and readme?

Also, help me a bit to build (I'm not sure how a third-party package would integrate with starlette-admin) it, the integration aspect is my blind spot.

Edit: Here is the list of the fields that I kept in mind...

• Jodit obviously...
• froala/wysiwyg-editor: The next generation Javascript WYSIWYG HTML Editor.
• microsoft/monaco-editor: A browser based code editor
• Editor | TOAST UI :: Make Your Web Delicious! and also some components from TOAST UI
• basecamp/trix: A rich text editor for everyday writing
• codex-team/editor.js: A block-style editor with clean JSON output which looks quite interesting...
• arikchakma/maily.to
• codemirror/codemirror5: In-browser code editor (version 5, legacy)
• pandao/editor.md: The open source embeddable online markdown editor (component). - it's not updated for 4 years but looks quite good.
• benweet/stackedit: In-browser Markdown editor
• lepture/editor: A markdown editor. http://lab.lepture.com/editor/ - it's terribly old but IDK why I saved it in my notes...
• And some of the technologies listed here.
• CKEditor4 if it'll be another package.
• CronEditorField, think of something like the editor in this repo: Marak/cron-editor: Visual Cron Editor - Edit and Create Cron Jobs With Ease and it will be helpful for Enhancement: APScheduler Integration #433
• HTMXSwapField, it's a clickable (button or link). It'll swap it's content with a request using HTMX. (This brings another idea, "template_response" for row and batch actions?)
• ModalField, based on HTMXSwapField but with a modal.

Edit: #381, #380 and #379 are the fields that I wrote and pull requested.

[jowilf]

@jowilf As I said, I have a lot more fields in mind, so you might think that creating a third-party package (something called 'starlette-admin-fields') is a better idea.

I agree. I also think that it's a better idea.

If that is the case would you mention and reference this hypothetical package in the documentation and readme?

we can add a third-party packages section similar to https://www.starlette.io/third-party-packages/

[hasansezertasan]

I agree. I also think that it's a better idea.

Great, how do we proceed from here? What should we do next?

we can add a third-party packages section similar to https://www.starlette.io/third-party-packages/

Fantastic!

I believe we can add a parameter to the BaseAdmin class, something like extra_template_loaders, and users can extend the templates folder with third-party packages.

starlette-admin/starlette_admin/base.py

Lines 191 to 196 in 769a85f

	templates.env.loader = ChoiceLoader(
	[
	FileSystemLoader(self.templates_dir),
	PackageLoader("starlette_admin", "templates"),
	]
	)

Example in mind:

    def _setup_templates(self) -> None:
        templates = Jinja2Templates(self.templates_dir, extensions=["jinja2.ext.i18n"])
        templates.env.loader = ChoiceLoader(
            [
                FileSystemLoader(self.templates_dir),
                *self.extra_template_loaders,
                PackageLoader("starlette_admin", "templates"),
            ]
        )
        ...

And I think we can follow the same pattern with the statics folder. I'm open to suggestions but this is the first way of doing this that popped into my mind.

WDYT of this design @jowilf?

[hasansezertasan]

Field Proposals: this is not exactly a proposal but these projects are inspirational...

• nathancahill/Flask-Edits
• artemShelest/flask-admin-subview

[hasansezertasan]

I started to build a third-party package to cover these fields: hasansezertasan/starlette-admin-fields: Extra fields to use with Starlette Admin