salesforceiq-oss / popgun Goto Github PK

This thing is huge, needs a lot of TLC. Break down show/hidePop logic.

TSIA. DEBATE!

init(): void

Registers mutation observer and sets up event listeners.

registerGroup(groupId: string, groupOpts: IGroup): void

Store a group w/ options to reuse. schema is a base set of options, options attr will precedence over schema

registerSchema(schemaId: string, opts: IOptions): void

Store a schema of options

getPopFromGroupId(groupId: string): Pop

Given a group id, return a pop

getPopState(groupId: string): string

Return the state (Showing, Hidden, Pre_Hide, etc) of a pop

isPopAlreadyOpenForTarget(target: Element): boolean

Given a popgun target, return whether a pop is showing for it

isPopAlreadyOpenForGroup(groupId: string): boolean

Given a group id, return whether a pop is showing for it

reposition(groupId: string): void

Given a group id, reposition the open pop

showPop(target: Element, isPinned: boolean, trigger: string): void

Given a popgun target, manually show a pop.

hidePop(target: Element, hideFullChain: boolean): void

Given a popgun target, manually hide the open pop.

Some things to note,

1. clean up _listenForScroll. Could possibly be a single listener instead of adding and removing them on pop show/hide.
2. Modularize more of the code for reusability and ease of understanding.
3. Create Wiki to document architecture.
4. ??
5. Profit.