lunit-io / insight-viewer

medical image viewer component for React
https://insight-viewer.lunit.io
MIT License
34 stars 6 forks source link

VIEWER-136 / AnnotationOverlay Props type, 네이밍 개선 #392

Closed LTakhyunKim closed 1 year ago

LTakhyunKim commented 1 year ago

📝 Description

AnnotationOverlay onChange 적용 전, 기존 props type 및 네이밍 개선 작업을 진행합니다. (onChange 와 함께 올리기엔 수정 사항이 많아 PR 을 분리합니다.)

✔️ PR Type

What kind of change does this PR introduce?

🎯 Current behavior

select, hover 관련 props 는 항상 필수값으로 들어갑니다.

isEditing props 를 통해 Annotation Remove, Select 기능을 지원합니다.

Issue Number: https://lunit.atlassian.net/browse/VIEWER-136

🚀 New behavior

select, hover 관련 props 는 옵셔널입니다. 916f5a8 (사용하지 않을 경우 해당 props 를 넣지 않아도 됩니다.)

ClickAction 타입을 추가합니다. 15d5bad AnnotationOverlay 에서 Click 시 실행할 액션을 지정합니다. isEditing 의 대체 prop 이며, 보다 명확한 네이밍을 제공하기 위해 type 과 네이밍을 수정했습니다.

isEditing prop 에서 clickAction 으로 수정합니다. 7ca182e

💣 Is this a breaking change?

isEditing 대신 clickAction 을 사용해야합니다. 이와 더불어 boolean 에서 'remove' 혹은 'select' 와 같은 string 타입으로 수정해야합니다.

github-actions[bot] commented 1 year ago

preview: https://insight-viewer--pr-392.f.lunit.io/

@lunit/insight-viewer docs