@elemental/ui / Function

lmnSetLabels

Saves custom labels for the helpers and resources in the Docebo UI library.

Presentation

function lmnSetLabels(
  labels: Partial<{
    common: Partial<{
      disabledStatusDetails: string;
      close: string;
      clear: string;
      requiredMarker: string;
      disabledMarker: string;
      opensInANewTab: string;
      toolForVisualCustomization: string;
      error: string;
      alert: string;
    }>;
    accordion: Partial<{ collapsePanel: string; expandPanel: string }>;
    breadcrumbs: Partial<{ previousPathLevel: string; showPath: string }>;
    calendar: Partial<{
      previousYearsRange: string;
      nextYearsRange: string;
      yearsRange: string;
      nextYear: string;
      previousYear: string;
      nextMonth: string;
      previousMonth: string;
      monthsList: string;
      daysList: string;
      years: string;
      months: string;
      chooseYear: string;
      chooseMonthAndYear: string;
      currentYear: string;
      currentMonth: string;
      today: string;
      minDateDisabled: string;
      maxDateDisabled: string;
    }>;
    carousel: Partial<{
      nextPage: string;
      previousPage: string;
      currentOfTotalPages: string;
      previousPageDisabled: string;
      nextPageDisabled: string;
    }>;
    chipSet: Partial<{
      delete: string;
      useBackspaceToDeleteFocusedItems: string;
    }>;
    date: Partial<{
      cancel: string;
      confirm: string;
      chooseDate: string;
      close: string;
      dateAndTimeSelection: string;
      keyboardShortcuts: string;
      legend: string;
      backToCalendar: string;
      borderedNumber: string;
      numberOnly: string;
      numberWithBackground: string;
      numberWithLowOpacity: string;
      date: string;
      time: string;
      period: string;
      am: string;
      pm: string;
      enterSpaceBarKey: string;
      leftAndRightArrowKeys: string;
      upAndDownArrowKeys: string;
      pageUpAndPageDownKeys: string;
      escKey: string;
      errorTitle: string;
      errorDescription: string;
      timeError: string;
      moveDay: string;
      moveDayRtl: string;
      moveWeek: string;
      closeCalendar: string;
      currentDay: string;
      selectableDay: string;
      selectedDay: string;
      disabledDay: string;
      selectADate: string;
    }>;
    expandableContent: Partial<{ showMore: string; showLess: string }>;
    facet: Partial<{
      changePosition: string;
      moveToPosition: string;
      moveToPositionDisabledReason: string;
      collapsePanel: string;
      expandPanel: string;
    }>;
    inputRating: Partial<{ star: string; stars: string }>;
    inputSelect: Partial<{
      addQuery: string;
      charactersInserted: string;
      optionsInserted: string;
      itemsAlreadySelected: string;
      useBackspaceToCancelSelectedItems: string;
      nResultsAvailableWithInstructions: string;
    }>;
    inputSlider: Partial<{
      currentOfMax: string;
      invalidValueNumbersOnly: string;
    }>;
    inputText: Partial<{
      showPassword: string;
      hidePassword: string;
      charactersInserted: string;
    }>;
    inputUpload: Partial<{ currentOfMaxFiles: string; files: string }>;
    menu: Partial<{ closeSubMenu: string; backToParentMenu: string }>;
    paginationBar: Partial<{
      currentOfMax: string;
      currentPage: string;
      currentPageAlternative: string;
      currentSelection: string;
      goToPage: string;
      itemsCount: string;
      ofManyPages: string;
      countOfManyPages: string;
      rangeOfManyPages: string;
      rangeOfManyPagesAlternative: string;
      nextPage: string;
      nextPageButtonDisabledReason: string;
      onePageIsAvailable: string;
      page: string;
      pages: string;
      pagesAreAvailable: string;
      pagesCount: string;
      paginatorRange: string;
      paginatorRangeAlternative: string;
      previousPage: string;
      previousPageButtonDisabledReason: string;
      replacedPageNumber: string;
      rowsPerPage: string;
    }>;
    stepper: Partial<{
      currentOfTotalSteps: string;
      nextStep: string;
      stepPending: string;
      stepInProgress: string;
      stepPartiallyCompleted: string;
      stepCompleted: string;
      stepError: string;
      stepErrors: string;
      backToStep: string;
    }>;
    toast: Partial<{ platformFeedback: string }>;
    search: Partial<{
      searchInScope: string;
      search: string;
      searchOptions: string;
    }>;
    dataBrowser: Partial<{ close: string }>;
    filterMultipleSelection: Partial<{
      showMore: string;
      showLess: string;
      showMoreAriaLabel: string;
      showLessAriaLabel: string;
      results: string;
      resultsAnnouncement: string;
      noResults: string;
      tryDifferentCriteria: string;
    }>;
    table: Partial<{
      resizeColumn: string;
      sortingColumn: string;
      sortAscending: string;
      sortDescending: string;
      removeSorting: string;
      selectRow: string;
      selectAllRows: string;
    }>;
  }>,
): void;

Returns

void

Parameters

NameTypeDescription
labels
Partial<{ common: Partial<{ disabledStatusDetails: string; close: string; clear: string; requiredMarker: string; disabledMarker: string; opensInANewTab: string; toolForVisualCustomization: string; error: string; alert: string; }>; accordion: Partial<{ collapsePanel: string; expandPanel: string; }>; breadcrumbs: Partial<{ previousPathLevel: string; showPath: string; }>; calendar: Partial<{ previousYearsRange: string; nextYearsRange: string; yearsRange: string; nextYear: string; previousYear: string; nextMonth: string; previousMonth: string; monthsList: string; daysList: string; years: string; months: string; chooseYear: string; chooseMonthAndYear: string; currentYear: string; currentMonth: string; today: string; minDateDisabled: string; maxDateDisabled: string; }>; carousel: Partial<{ nextPage: string; previousPage: string; currentOfTotalPages: string; previousPageDisabled: string; nextPageDisabled: string; }>; chipSet: Partial<{ delete: string; useBackspaceToDeleteFocusedItems: string; }>; date: Partial<{ cancel: string; confirm: string; chooseDate: string; close: string; dateAndTimeSelection: string; keyboardShortcuts: string; legend: string; backToCalendar: string; borderedNumber: string; numberOnly: string; numberWithBackground: string; numberWithLowOpacity: string; date: string; time: string; period: string; am: string; pm: string; enterSpaceBarKey: string; leftAndRightArrowKeys: string; upAndDownArrowKeys: string; pageUpAndPageDownKeys: string; escKey: string; errorTitle: string; errorDescription: string; timeError: string; moveDay: string; moveDayRtl: string; moveWeek: string; closeCalendar: string; currentDay: string; selectableDay: string; selectedDay: string; disabledDay: string; selectADate: string; }>; expandableContent: Partial<{ showMore: string; showLess: string; }>; facet: Partial<{ changePosition: string; moveToPosition: string; moveToPositionDisabledReason: string; collapsePanel: string; expandPanel: string; }>; inputRating: Partial<{ star: string; stars: string; }>; inputSelect: Partial<{ addQuery: string; charactersInserted: string; optionsInserted: string; itemsAlreadySelected: string; useBackspaceToCancelSelectedItems: string; nResultsAvailableWithInstructions: string; }>; inputSlider: Partial<{ currentOfMax: string; invalidValueNumbersOnly: string; }>; inputText: Partial<{ showPassword: string; hidePassword: string; charactersInserted: string; }>; inputUpload: Partial<{ currentOfMaxFiles: string; files: string; }>; menu: Partial<{ closeSubMenu: string; backToParentMenu: string; }>; paginationBar: Partial<{ currentOfMax: string; currentPage: string; currentPageAlternative: string; currentSelection: string; goToPage: string; itemsCount: string; ofManyPages: string; countOfManyPages: string; rangeOfManyPages: string; rangeOfManyPagesAlternative: string; nextPage: string; nextPageButtonDisabledReason: string; onePageIsAvailable: string; page: string; pages: string; pagesAreAvailable: string; pagesCount: string; paginatorRange: string; paginatorRangeAlternative: string; previousPage: string; previousPageButtonDisabledReason: string; replacedPageNumber: string; rowsPerPage: string; }>; stepper: Partial<{ currentOfTotalSteps: string; nextStep: string; stepPending: string; stepInProgress: string; stepPartiallyCompleted: string; stepCompleted: string; stepError: string; stepErrors: string; backToStep: string; }>; toast: Partial<{ platformFeedback: string; }>; search: Partial<{ searchInScope: string; search: string; searchOptions: string; }>; dataBrowser: Partial<{ close: string; }>; filterMultipleSelection: Partial<{ showMore: string; showLess: string; showMoreAriaLabel: string; showLessAriaLabel: string; results: string; resultsAnnouncement: string; noResults: string; tryDifferentCriteria: string; }>; table: Partial<{ resizeColumn: string; sortingColumn: string; sortAscending: string; sortDescending: string; removeSorting: string; selectRow: string; selectAllRows: string; }>; }>

@param labels The labels to be customized.