search

iTwin / appui

Monorepo for iTwin.js AppUi
MIT License
8 stars 2 forks source link

missing details in docs - AccuDrawshortcut #464

Closed YashodipD closed 10 months ago

YashodipD commented 1 year ago

I found out we cannot show AccuDrawKeyboardShortcuts without passing an instance of FrameworkToolAdmin to toolAdmin prop of viewer. It is not mentioned anywhere in the docs.

Add note at the end of this page - https://www.itwinjs.org/reference/appui-react/accudraw/accudrawkeyboardshortcuts/

Add more details related to this in the description of - https://www.npmjs.com/package/@itwin/web-viewer-react

raplemie commented 1 year ago

Thanks for the report, we'll look into this!

raplemie commented 8 months ago

Hi @YashodipD, I updated the documentation and the page now have links to the relevant documentation, which should give the proper information that the FrameworkToolAdmin is required and where it should be used. That should give information for web-viewer as well, as the user should start from AccuDrawKeyboardShortcuts regardless. Let us know if that seems correct!

YashodipD commented 8 months ago

In ui/appui-react/src/appui-react/tools/FrameworkToolAdmin.ts this file , we mentioned about setting focus to Home. I did not see anywhere written how do we do it. I know we do it using esc however how will newcomer/outsider will know about it. image

raplemie commented 8 months ago

setFocusToHome is a method on UiFramework.keyboardShortcuts, which is linked there, I think that should be enough.

YashodipD commented 8 months ago

Looking good, Thank you!