Skip to content

feat: patch for support handleCodeInfo #189

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: patch for support handleCodeInfo #189

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/Inspector/Inspector.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,13 @@ export interface InspectorProps {
* whether disable click react component to open IDE for view component code
*/
disableLaunchEditor?: boolean,
/**
* custom handler for component name and info display
* @param name component name
* @param info component info (file path)
* @returns [displayName, displayInfo] tuple for display
*/
handleCodeInfo?: (name: string, info?: string) => [string, string],
}

export const Inspector: React.FC<InspectorProps> = (props) => {
Expand All @@ -47,6 +54,7 @@ export const Inspector: React.FC<InspectorProps> = (props) => {
onHoverElement,
onClickElement,
disableLaunchEditor,
handleCodeInfo,
children,
} = props

Expand All @@ -63,7 +71,7 @@ export const Inspector: React.FC<InspectorProps> = (props) => {
}

const startInspect = () => {
const overlay = new Overlay()
const overlay = new Overlay(handleCodeInfo)
overlayRef.current = overlay

const stopCallback = setupHighlighter({
Expand Down
29 changes: 22 additions & 7 deletions src/Inspector/Overlay.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,10 @@ export default class Overlay {
tip: OverlayTip
rects: Array<OverlayRect>
removeCallback: (this: Overlay) => void
handleCodeInfo?: (name: string, info?: string) => [string, string]

constructor() {
constructor(handleCodeInfo?: (name: string, info?: string) => [string, string]) {
this.handleCodeInfo = handleCodeInfo
// Find the root window, because overlays are positioned relative to it.
const currentWindow = window.__REACT_DEVTOOLS_TARGET_WINDOW__ || window
this.window = currentWindow
Expand Down Expand Up @@ -283,12 +285,25 @@ export default class Overlay {
}
}

this.tip.updateText(
name,
info,
outerBox.right - outerBox.left,
outerBox.bottom - outerBox.top,
)
const width = outerBox.right - outerBox.left
const height = outerBox.bottom - outerBox.top

if (this.handleCodeInfo) {
const [displayName, displayInfo] = this.handleCodeInfo(name || '', info)
this.tip.updateText(
displayName,
displayInfo,
width,
height,
)
} else {
this.tip.updateText(
name || '',
info,
width,
height,
)
}
const tipBounds = getNestedBoundingClientRect(
this.tipBoundsWindow.document.documentElement,
this.window,
Expand Down