Skip to content

Enum: CalendarIntervalType key-value pairs not identical and some not @public #4271

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

Open
boghyon opened this issue Apr 29, 2025 · 1 comment

Comments

@boghyon
Copy link
Contributor

boghyon commented Apr 29, 2025

This is a sub-issue of #4201 specifically for the following enum:

  • sap/ui/unified/library.CalendarIntervalType which is known to be used at least by the intervalType property of sap.m.PlanningCalendarView and sap.ui.unified.CalendarRow, and by sap.m.PlanningCalendar's viewKey.

    /**
    * Interval types in a <code>CalendarRow</code>.
    *
    * @enum {string}
    * @public
    * @since 1.34.0
    */
    thisLib.CalendarIntervalType = {
    /**
    * Intervals have the size of one hour.
    * @public
    */
    Hour : "Hour",
    /**
    * Intervals have the size of one day.
    * @public
    */
    Day : "Day",
    /**
    * Intervals have the size of one month.
    * @public
    */
    Month : "Month",
    /**
    * Intervals have the size of one day where 7 days are displayed, starting with the first day of the week.
    *
    * Note: This interval type is NOT supported when creating a custom sap.m.PlanningCalendarView.
    *
    * @since 1.44
    */
    Week : "Week",
    /**
    * Intervals have the size of one day where 31 days are displayed, starting with the first day of the month.
    *
    * Note: This interval type is NOT supported when creating a custom sap.m.PlanningCalendarView.
    *
    * @since 1.46
    */
    OneMonth : "One Month"
    };

    Additionally, the Week and OneMonth are missing @public and therefore not visible in the API Reference page. Is it by design?

@i556484
Copy link
Member

i556484 commented Apr 29, 2025

Hello @boghyon ,
Thank you for sharing this finding. I've created an internal incident DINC0487655. The status of the issue will be updated here in GitHub.

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

No branches or pull requests

2 participants