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

Add defineExpose to Treeselect component #2

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

Conversation

elizabeth011685
Copy link

Integrated defineExpose to the Treeselect component to expose the clear method. This change facilitates external access to the method, improving component flexibility and reusability.

Integrated defineExpose to the Treeselect component to expose the clear method. This change facilitates external access to the method, improving component flexibility and reusability.
@Alexbrazdasilva
Copy link

@elizabeth011685
Wouldn't it be a case of exposing the instance?

const instance = computed(() => ({
  name: props.name || 'vue-treeselect',
  hasValue: hasValue,
  trigger: state.trigger,
  forest: state.forest,
  localSearch: state.localSearch,
  remoteSearch: state.remoteSearch,
  isReady: state.isReady,
  rootOptionsStates: state.rootOptionsStates,
  internalValue: internalValue,
  selectedNodes: selectedNodes,
  $slots: slots,
  $refs: {
    control: control.value,
    wrapper: wrapper.value,
    portal: portal.value,
    menu: rmenu.value,
  },
  menu: state.menu,
  single: single,
  verifyProps,
  resetFlags,
  initialize,
  getInstanceId,
  getValue,
  getNode,
  createFallbackNode,
  extractCheckedNodeIdsFromValue,
  extractNodeFromValue,
  fixSelectedNodeIds,
  keepDataOfSelectedNodes,
  isSelected,
  traverseDescendantsBFS,
  traverseDescendantsDFS,
  traverseAllNodesDFS,
  traverseAllNodesByIndex,
  toggleClickOutsideEvent,
  getValueContainer,
  getInput,
  focusInput,
  blurInput,
  handleMouseDown,
  handleClickOutside,
  handleLocalSearch,
  getRemoteSearchEntry,
  shouldExpand,
  shouldOptionBeIncludedInSearchResult,
  shouldShowOptionInMenu,
  getControl,
  getMenu,
  setCurrentHighlightedOption,
  resetHighlightedOptionWhenNecessary,
  highlightFirstOption,
  highlightPrevOption,
  highlightNextOption,
  highlightLastOption,
  resetSearchQuery,
  closeMenu,
  openMenu,
  toggleMenu,
  toggleExpanded,
  buildForestState,
  enhancedNormalizer,
  normalize,
  loadRootOptions,
  loadChildrenOptions,
  callLoadOptionsProp,
  checkDuplication,
  verifyNodeShape,
  select,
  clear,
  _selectNode,
  _deselectNode,
  addValue,
  removeValue,
  removeLastValue,
  saveMenuScrollPosition,
  restoreMenuScrollPosition,
  handleRemoteSearch,
  allowClearingDisabled: props.allowClearingDisabled,
  allowSelectingDisabledDescendants: props.allowSelectingDisabledDescendants,
  alwaysOpen: props.alwaysOpen,
  appendToBody: props.appendToBody,
  async: props.async,
  autoFocus: props.autoFocus,
  autoLoadRootOptions: props.autoLoadRootOptions,
  autoDeselectAncestors: props.autoDeselectAncestors,
  autoDeselectDescendants: props.autoDeselectDescendants,
  autoSelectAncestors: props.autoSelectAncestors,
  autoSelectDescendants: props.autoSelectDescendants,
  backspaceRemoves: props.backspaceRemoves,
  beforeClearAll: props.beforeClearAll,
  branchNodesFirst: props.branchNodesFirst,
  cacheOptions: props.cacheOptions,
  clearable: props.clearable,
  clearAllText: props.clearAllText,
  clearOnSelect: props.clearOnSelect,
  clearValueText: props.clearValueText,
  closeOnSelect: props.closeOnSelect,
  defaultExpandLevel: props.defaultExpandLevel,
  defaultOptions: props.defaultOptions,
  deleteRemoves: props.deleteRemoves,
  delimiter: props.delimiter,
  flattenSearchResults: props.flattenSearchResults,
  disableBranchNodes: props.disableBranchNodes,
  disabled: props.disabled,
  disableFuzzyMatching: props.disableFuzzyMatching,
  flat: props.flat,
  instanceId: instanceId,
  joinValues: props.joinValues,
  limit: props.limit,
  limitText: props.limitText,
  loadingText: props.loadingText,
  loadOptions: props.loadOptions,
  matchKeys: props.matchKeys,
  maxHeight: props.maxHeight,
  multiple: props.multiple,
  noChildrenText: props.noChildrenText,
  noOptionsText: props.noOptionsText,
  noResultsText: props.noResultsText,
  normalizer: props.normalizer,
  openDirection: props.openDirection,
  openOnClick: props.openOnClick,
  openOnFocus: props.openOnFocus,
  options: props.options,
}))

@r2rka1
Copy link
Owner

r2rka1 commented Jan 4, 2025

I think we should look for a better way to expose API. For instance - one possible solution would be to return an API object on @ready event.

@elizabeth011685 @Alexbrazdasilva

<tree-select @ready="handleOnReady" />
// ...

const treeselectApi = ref(null);

const handleOnReady = (api) => { 
  treeselectApi.value = api
}

// ...
const myMethod = () => {
  // ...
  treeselectApi.value.clear()
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants