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

[nz-code-editor] Configure MonacoEnvironment before (first) load #6502

Closed
Airblader opened this issue Mar 10, 2021 · 9 comments · Fixed by #7359
Closed

[nz-code-editor] Configure MonacoEnvironment before (first) load #6502

Airblader opened this issue Mar 10, 2021 · 9 comments · Fixed by #7359
Assignees
Labels
Component: CodeEditor Good First Issue Issues recommended for first-time contributor help wanted

Comments

@Airblader
Copy link
Collaborator

What problem does this feature solve?

Since monaco-editor 0.22.0¹, the global monaco object is only defined if you add

window.MonacoEnvironment = { globalAPI: true };

It would be nice if ng-zorro had some hook to configure MonacoEnvironment (also for potential other use-cases) before monaco-editor is actually loaded. Also, the documentation for onLoad is now slightly incorrect/incomplete:

The hook invoked when the resource of monaco editor is loaded. At this moment and afterwards the global variable monaco is usable

¹ https://github.com/microsoft/monaco-editor/blob/main/CHANGELOG.md

What does the proposed API look like?

Extend NzConfig#codeEditor with either an object or a function to modify MonacoEnvironment.

@zorro-bot
Copy link

zorro-bot bot commented Mar 10, 2021

Hello @Airblader. We totally like your proposal/feedback, welcome to send us a Pull Request for it. Please fill the Pull Request Template here, provide documentation/test cases if needed and make sure CI passed, we will review it soon. Appreciate it advance and we are looking forward to your contribution!

你好 @Airblader, 我们完全同意你的提议/反馈,欢迎直接在此仓库 创建一个 Pull Request 来解决这个问题。请务必填写 Pull Request 内的预设模板,提供改动所需相应的测试用例、文档等,并确保 CI 通过,我们会尽快进行 Review,提前感谢和期待您的贡献!
giphy

@thekhegay
Copy link

@hullis @simplejason

"ng-zorro-antd": "^13.2.0",

Error: node_modules/ng-zorro-antd/core/config/config.d.ts:9:29 - error TS2307: Cannot find module 'monaco-editor' or its corresponding type declarations.

import { Environment } from 'monaco-editor';

@anthoniriv
Copy link

@hullis @simplejason

"ng-zorro-antd": "^13.2.0",


Error: node_modules/ng-zorro-antd/core/config/config.d.ts:9:29 - error TS2307: Cannot find module 'monaco-editor' or its corresponding type declarations.



import { Environment } from 'monaco-editor';


Did you fix it? Same problem here

@wzhudev
Copy link
Member

wzhudev commented Apr 27, 2022

Hi @thekhegay. Have you installed the monaco-editor package? ng-zorro-antd does not list monaco-editor as a dependency for some reason (monaco-editor component is an experimental component). Sorry, seems a problem on our side.

@anthoniriv
Copy link

I had to install monaco-editor to solve the problem idk why. I don't use it

@wzhudev
Copy link
Member

wzhudev commented Apr 27, 2022

I had to install monaco-editor to solve the problem idk why. I don't use it

For sorry that. The problem is on our side. We will fix it soon.

@wzhudev
Copy link
Member

wzhudev commented Apr 27, 2022

import { Environment } from 'monaco-editor';

@yangjunhan Should not import type declaration here. Forcing all users to install monaco-editor.

@thekhegay
Copy link

@hullis any updates?

@wzhudev
Copy link
Member

wzhudev commented May 1, 2022

@hullis any updates?

This problem should have been fixed in our recent release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: CodeEditor Good First Issue Issues recommended for first-time contributor help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants