@uob-web-and-digital/component-library 2.7.0 → 2.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +111 -111
- package/package.json +121 -121
- package/dist/components/atoms/BreadcrumbLink/BreadcrumbLink.d.ts +0 -10
- package/dist/components/atoms/BreadcrumbLink/BreadcrumbLink.stories.d.ts +0 -11
- package/dist/components/atoms/CalendarGraphic/CalendarGraphic.d.ts +0 -10
- package/dist/components/atoms/CalendarGraphic/CalendarGraphic.stories.d.ts +0 -12
- package/dist/components/atoms/CampusSelectorLink/CampusSelectorLink.d.ts +0 -17
- package/dist/components/atoms/CampusSelectorLink/CampusSelectorLink.stories.d.ts +0 -11
- package/dist/components/atoms/Checkbox/Checkbox.d.ts +0 -13
- package/dist/components/atoms/Checkbox/Checkbox.stories.d.ts +0 -10
- package/dist/components/atoms/CourseDeliveryPill/CourseDeliveryPill.d.ts +0 -10
- package/dist/components/atoms/CourseDeliveryPill/CourseDeliveryPill.stories.d.ts +0 -11
- package/dist/components/atoms/CourseIcon/CourseIcon.d.ts +0 -11
- package/dist/components/atoms/CourseIcon/CourseIcon.stories.d.ts +0 -12
- package/dist/components/atoms/DateInput/DateInput.d.ts +0 -12
- package/dist/components/atoms/DateInput/DateInput.stories.d.ts +0 -6
- package/dist/components/atoms/ExampleTheming/ExampleTheming.d.ts +0 -17
- package/dist/components/atoms/ExampleTheming/ExampleTheming.stories.d.ts +0 -12
- package/dist/components/atoms/FormInput/FormInput.d.ts +0 -23
- package/dist/components/atoms/FormInput/FormInput.stories.d.ts +0 -11
- package/dist/components/atoms/FormInput/defaultProps.d.ts +0 -2
- package/dist/components/atoms/FormSelect/FormSelect.d.ts +0 -23
- package/dist/components/atoms/FormSelect/FormSelect.stories.d.ts +0 -12
- package/dist/components/atoms/FormSelect/defaultProps.d.ts +0 -2
- package/dist/components/atoms/Heading/Heading.d.ts +0 -7
- package/dist/components/atoms/Heading/Heading.stories.d.ts +0 -12
- package/dist/components/atoms/IconButton/IconButton.d.ts +0 -20
- package/dist/components/atoms/IconButton/IconButton.stories.d.ts +0 -29
- package/dist/components/atoms/IconButton/defaultProps.d.ts +0 -12
- package/dist/components/atoms/IconControl/IconControl.d.ts +0 -17
- package/dist/components/atoms/IconControl/IconControl.stories.d.ts +0 -13
- package/dist/components/atoms/IconControl/defaultProps.d.ts +0 -3
- package/dist/components/atoms/Icons/Icons.d.ts +0 -18
- package/dist/components/atoms/Icons/Icons.stories.d.ts +0 -12
- package/dist/components/atoms/Image/Image.d.ts +0 -16
- package/dist/components/atoms/LinkStandard/LinkStandard.d.ts +0 -11
- package/dist/components/atoms/LinkStandard/LinkStandard.stories.d.ts +0 -11
- package/dist/components/atoms/LinkWithArrow/LinkWithArrow.d.ts +0 -19
- package/dist/components/atoms/LinkWithArrow/LinkWithArrow.stories.d.ts +0 -13
- package/dist/components/atoms/LinkWithIcon/LinkWithIcon.d.ts +0 -16
- package/dist/components/atoms/LinkWithIcon/LinkWithIcon.stories.d.ts +0 -11
- package/dist/components/atoms/LogoLink/LogoLink.d.ts +0 -13
- package/dist/components/atoms/LogoLink/LogoLink.stories.d.ts +0 -13
- package/dist/components/atoms/LogoLink/defaultProps.d.ts +0 -2
- package/dist/components/atoms/MainWrapper/MainWrapper.d.ts +0 -4
- package/dist/components/atoms/NavLink/NavLink.d.ts +0 -14
- package/dist/components/atoms/NavLink/NavLink.stories.d.ts +0 -18
- package/dist/components/atoms/PageLink/PageLink.d.ts +0 -18
- package/dist/components/atoms/PageLink/PageLink.stories.d.ts +0 -18
- package/dist/components/atoms/ParagraphLink/ParagraphLink.d.ts +0 -17
- package/dist/components/atoms/ParagraphLink/ParagraphLink.stories.d.ts +0 -11
- package/dist/components/atoms/Parallax/Parallax.d.ts +0 -7
- package/dist/components/atoms/Pill/Pill.d.ts +0 -13
- package/dist/components/atoms/Pill/Pill.stories.d.ts +0 -11
- package/dist/components/atoms/RadioButton/RadioButton.d.ts +0 -13
- package/dist/components/atoms/RadioButton/RadioButton.stories.d.ts +0 -10
- package/dist/components/atoms/ReverseLinkWithArrow/ReverseLinkWithArrow.d.ts +0 -19
- package/dist/components/atoms/ReverseLinkWithArrow/ReverseLinkWithArrow.stories.d.ts +0 -13
- package/dist/components/atoms/SearchResultDetail/SearchResultDetail.d.ts +0 -12
- package/dist/components/atoms/SearchResultDetail/SearchResultDetail.stories.d.ts +0 -10
- package/dist/components/atoms/TextButton/TextButton.d.ts +0 -32
- package/dist/components/atoms/TextButton/TextButton.stories.d.ts +0 -14
- package/dist/components/atoms/TextButtonWithIcon/TextButtonWithIcon.d.ts +0 -42
- package/dist/components/atoms/TextButtonWithIcon/TextButtonWithIcon.stories.d.ts +0 -14
- package/dist/components/atoms/Video/Video.d.ts +0 -10
- package/dist/components/atoms/Video/Video.stories.d.ts +0 -15
- package/dist/components/atoms/Video/defaultProps.d.ts +0 -2
- package/dist/components/atoms/VideoPlaceholder/VideoPlaceholder.d.ts +0 -13
- package/dist/components/atoms/VideoPlaceholder/VideoPlaceholder.stories.d.ts +0 -6
- package/dist/components/atoms/VideoPlaceholder/defaultProps.d.ts +0 -2
- package/dist/components/molecules/AccordionItem/AccordionItem.d.ts +0 -27
- package/dist/components/molecules/AccordionItem/AccordionItem.stories.d.ts +0 -19
- package/dist/components/molecules/CampusSelector/CampusSelector.d.ts +0 -15
- package/dist/components/molecules/CampusSelector/CampusSelector.stories.d.ts +0 -11
- package/dist/components/molecules/CardFact/CardFact.d.ts +0 -16
- package/dist/components/molecules/CardFact/CardFact.stories.d.ts +0 -14
- package/dist/components/molecules/CardFeatured/CardFeatured.d.ts +0 -32
- package/dist/components/molecules/CardFeatured/CardFeatured.stories.d.ts +0 -11
- package/dist/components/molecules/CardFeatured/animationVariants.d.ts +0 -44
- package/dist/components/molecules/CardFeatured/defaultProps.d.ts +0 -2
- package/dist/components/molecules/CardFeaturedNews/CardFeaturedNews.d.ts +0 -23
- package/dist/components/molecules/CardFeaturedNews/CardFeaturedNews.stories.d.ts +0 -13
- package/dist/components/molecules/CardImage/CardImage.d.ts +0 -15
- package/dist/components/molecules/CardImage/CardImage.stories.d.ts +0 -18
- package/dist/components/molecules/CardImage/defaultProps.d.ts +0 -2
- package/dist/components/molecules/CardMenu/CardMenu.d.ts +0 -19
- package/dist/components/molecules/CardMenu/CardMenu.stories.d.ts +0 -14
- package/dist/components/molecules/CardModuleCard/CardModuleCard.d.ts +0 -14
- package/dist/components/molecules/CardModuleCard/CardModuleCard.stories.d.ts +0 -14
- package/dist/components/molecules/CardNews/CardNews.d.ts +0 -19
- package/dist/components/molecules/CardNews/CardNews.stories.d.ts +0 -15
- package/dist/components/molecules/CardNews/defaultProps.d.ts +0 -2
- package/dist/components/molecules/CardProfile/CardProfile.d.ts +0 -18
- package/dist/components/molecules/CardProfile/CardProfile.stories.d.ts +0 -13
- package/dist/components/molecules/CardPromo/CardPromo.d.ts +0 -34
- package/dist/components/molecules/CardPromo/CardPromo.stories.d.ts +0 -21
- package/dist/components/molecules/CardPromoProfile/CardPromoProfile.d.ts +0 -22
- package/dist/components/molecules/CardPromoProfile/CardPromoProfile.stories.d.ts +0 -15
- package/dist/components/molecules/CardPromoSignpost/CardPromoSignpost.d.ts +0 -30
- package/dist/components/molecules/CardPromoSignpost/CardPromoSignpost.stories.d.ts +0 -18
- package/dist/components/molecules/CardPromoVideo/CardPromoVideo.d.ts +0 -20
- package/dist/components/molecules/CardPromoVideo/CardPromoVideo.stories.d.ts +0 -16
- package/dist/components/molecules/CardRelatedCourse/CardRelatedCourse.d.ts +0 -15
- package/dist/components/molecules/CardRelatedCourse/CardRelatedCourse.stories.d.ts +0 -13
- package/dist/components/molecules/CardResearchStory/CardResearchStory.d.ts +0 -18
- package/dist/components/molecules/CardResearchStory/CardResearchStory.stories.d.ts +0 -13
- package/dist/components/molecules/CardScholarship/CardScholarship.d.ts +0 -21
- package/dist/components/molecules/CardScholarship/CardScholarship.stories.d.ts +0 -13
- package/dist/components/molecules/CardStaff/CardStaff.d.ts +0 -22
- package/dist/components/molecules/CardStaff/CardStaff.stories.d.ts +0 -14
- package/dist/components/molecules/CardVideo/CardVideo.d.ts +0 -18
- package/dist/components/molecules/CardVideo/CardVideo.stories.d.ts +0 -13
- package/dist/components/molecules/CarouselNav/CarouselNav.d.ts +0 -17
- package/dist/components/molecules/CarouselNav/CarouselNav.stories.d.ts +0 -11
- package/dist/components/molecules/FilterAccordion/FilterAccordion.d.ts +0 -32
- package/dist/components/molecules/FilterAccordion/FilterAccordion.stories.d.ts +0 -12
- package/dist/components/molecules/FilterAccordion/defaultProps.d.ts +0 -3
- package/dist/components/molecules/FilterAccordionSelect/FilterAccordionSelect.d.ts +0 -14
- package/dist/components/molecules/FilterAccordionSelect/FilterAccordionSelect.stories.d.ts +0 -10
- package/dist/components/molecules/FilterAccordionSelect/defaultProps.d.ts +0 -2
- package/dist/components/molecules/FullModal/FullModal.d.ts +0 -33
- package/dist/components/molecules/GenericDetail/GenericDetail.d.ts +0 -14
- package/dist/components/molecules/GenericDetail/GenericDetail.stories.d.ts +0 -12
- package/dist/components/molecules/Heading/Heading.d.ts +0 -23
- package/dist/components/molecules/Heading/Heading.stories.d.ts +0 -19
- package/dist/components/molecules/Heading/components/HeadingDescription.d.ts +0 -8
- package/dist/components/molecules/Heading/defaultProps.d.ts +0 -2
- package/dist/components/molecules/InPageNavigationLinks/InPageNavigationLinks.d.ts +0 -18
- package/dist/components/molecules/InPageNavigationLinks/InPageNavigationLinks.stories.d.ts +0 -14
- package/dist/components/molecules/InPageNavigationLinks/defaultProps.d.ts +0 -3
- package/dist/components/molecules/ListTable/ListTable.d.ts +0 -8
- package/dist/components/molecules/ListTable/ListTable.stories.d.ts +0 -10
- package/dist/components/molecules/ListingResultCard/Cards/AccomodationCard.d.ts +0 -15
- package/dist/components/molecules/ListingResultCard/Cards/CourseCard.d.ts +0 -18
- package/dist/components/molecules/ListingResultCard/Cards/EventCard.d.ts +0 -19
- package/dist/components/molecules/ListingResultCard/Cards/NewsCard.d.ts +0 -16
- package/dist/components/molecules/ListingResultCard/Cards/PageCard.d.ts +0 -13
- package/dist/components/molecules/ListingResultCard/Cards/ProfileCard.d.ts +0 -17
- package/dist/components/molecules/ListingResultCard/Cards/StaffCard.d.ts +0 -17
- package/dist/components/molecules/ListingResultCard/ListingResultCard.d.ts +0 -11
- package/dist/components/molecules/ListingResultCard/ListingResultCard.stories.d.ts +0 -20
- package/dist/components/molecules/ListingResultCard/defaultProps.d.ts +0 -15
- package/dist/components/molecules/LocationSelector/LocationSelector.d.ts +0 -14
- package/dist/components/molecules/LocationSelector/LocationSelector.stories.d.ts +0 -15
- package/dist/components/molecules/LocationSelector/defaultProps.d.ts +0 -2
- package/dist/components/molecules/ModalCTAButton/ModalCTAButton.d.ts +0 -11
- package/dist/components/molecules/ModalCTAButton/ModalCTAButton.stories.d.ts +0 -10
- package/dist/components/molecules/ModalCTAButton/defaultProps.d.ts +0 -2
- package/dist/components/molecules/MostReadNews/MostReadNews.d.ts +0 -12
- package/dist/components/molecules/MostReadNews/MostReadNews.stories.d.ts +0 -10
- package/dist/components/molecules/MostReadNews/defaultProps.d.ts +0 -2
- package/dist/components/molecules/PaginationNumbers/PaginationNumbers.d.ts +0 -9
- package/dist/components/molecules/PaginationNumbers/PaginationNumbers.stories.d.ts +0 -12
- package/dist/components/molecules/SearchResultDetailList/SearchResultDetailList.d.ts +0 -11
- package/dist/components/molecules/SearchResultDetailList/SearchResultDetailList.stories.d.ts +0 -10
- package/dist/components/molecules/SearchResultDetailList/defaultProps.d.ts +0 -2
- package/dist/components/molecules/ShareButtons/ShareButtons.d.ts +0 -11
- package/dist/components/molecules/ShareButtons/ShareButtons.stories.d.ts +0 -11
- package/dist/components/molecules/ShareButtons/defaultProps.d.ts +0 -2
- package/dist/components/molecules/Tab/Tab.d.ts +0 -53
- package/dist/components/molecules/Tab/TabItemProps.d.ts +0 -21
- package/dist/components/molecules/Tab/tabsUtils.d.ts +0 -1
- package/dist/components/molecules/TabList/TabsList.d.ts +0 -17
- package/dist/components/molecules/TabPanel/TabPanel.d.ts +0 -34
- package/dist/components/molecules/VideoWithPlaceholder/VideoWithPlaceholder.d.ts +0 -14
- package/dist/components/molecules/VideoWithPlaceholder/VideoWithPlaceholder.stories.d.ts +0 -6
- package/dist/components/molecules/VideoWithPlaceholder/defaultProps.d.ts +0 -2
- package/dist/components/molecules/Wysiwyg/Wysiwyg.d.ts +0 -9
- package/dist/components/molecules/Wysiwyg/Wysiwyg.stories.d.ts +0 -11
- package/dist/components/molecules/Wysiwyg/defaultProps.d.ts +0 -2
- package/dist/components/organisms/Accordion/Accordion.d.ts +0 -14
- package/dist/components/organisms/Accordion/accordion.stories.d.ts +0 -13
- package/dist/components/organisms/Accordion/defaultProps.d.ts +0 -5
- package/dist/components/organisms/AccreditationPromotion/AccreditationPromotion.d.ts +0 -22
- package/dist/components/organisms/AccreditationPromotion/AccreditationPromotion.stories.d.ts +0 -11
- package/dist/components/organisms/AccreditationPromotion/defaultProps.d.ts +0 -2
- package/dist/components/organisms/AlertBanner/AlertBanner.d.ts +0 -11
- package/dist/components/organisms/AlertBanner/AlertBanner.stories.d.ts +0 -15
- package/dist/components/organisms/AlertBanner/defaultProps.d.ts +0 -2
- package/dist/components/organisms/AnchorTarget/AnchorTarget.d.ts +0 -11
- package/dist/components/organisms/AnchorTarget/AnchorTarget.stories.d.ts +0 -15
- package/dist/components/organisms/Breadcrumbs/Breadcrumbs.d.ts +0 -18
- package/dist/components/organisms/Breadcrumbs/Breadcrumbs.stories.d.ts +0 -11
- package/dist/components/organisms/Breadcrumbs/defaultProps.d.ts +0 -2
- package/dist/components/organisms/CTAComponent/CTAComponent.d.ts +0 -24
- package/dist/components/organisms/CTAComponent/CTAComponent.stories.d.ts +0 -14
- package/dist/components/organisms/CTAComponent/defaultProps.d.ts +0 -4
- package/dist/components/organisms/Carousel/Carousel.d.ts +0 -29
- package/dist/components/organisms/Carousel/Carousel.stories.d.ts +0 -12
- package/dist/components/organisms/Carousel/defaultProps.d.ts +0 -7
- package/dist/components/organisms/CentreWrapper/CentreWrapper.d.ts +0 -11
- package/dist/components/organisms/CentreWrapper/CentreWrapper.stories.d.ts +0 -15
- package/dist/components/organisms/ClearingBanner/ClearingBanner.d.ts +0 -13
- package/dist/components/organisms/ClearingBanner/ClearingBanner.stories.d.ts +0 -10
- package/dist/components/organisms/ClearingBanner/defaultProps.d.ts +0 -2
- package/dist/components/organisms/CourseDeliveryPills/CourseDeliveryPills.d.ts +0 -9
- package/dist/components/organisms/CourseDeliveryPills/CourseDeliveryPills.stories.d.ts +0 -10
- package/dist/components/organisms/CourseDeliveryPills/defaultProps.d.ts +0 -2
- package/dist/components/organisms/EmbedWrapper/EmbedWrapper.d.ts +0 -20
- package/dist/components/organisms/EmbedWrapper/EmbedWrapper.stories.d.ts +0 -11
- package/dist/components/organisms/FactBoxes/FactBoxes.d.ts +0 -10
- package/dist/components/organisms/FactBoxes/FactBoxes.stories.d.ts +0 -16
- package/dist/components/organisms/FactBoxes/defaultProps.d.ts +0 -4
- package/dist/components/organisms/FeaturedContent/FeaturedContent.d.ts +0 -15
- package/dist/components/organisms/FeaturedContent/FeaturedContent.stories.d.ts +0 -11
- package/dist/components/organisms/FeaturedContent/defaultProps.d.ts +0 -2
- package/dist/components/organisms/FeaturedSignpost/FeaturedSignpost.d.ts +0 -27
- package/dist/components/organisms/FeaturedSignpost/FeaturedSignpost.stories.d.ts +0 -13
- package/dist/components/organisms/FeaturedSignpost/animationProperties.d.ts +0 -104
- package/dist/components/organisms/FeaturedSignpost/components/LinesOfIntent.d.ts +0 -8
- package/dist/components/organisms/FeaturedSignpost/components/SignpostImage.d.ts +0 -14
- package/dist/components/organisms/FeaturedSignpost/defaultProps.d.ts +0 -3
- package/dist/components/organisms/FeaturedVideo/FeaturedVideo.d.ts +0 -18
- package/dist/components/organisms/FeaturedVideo/FeaturedVideo.stories.d.ts +0 -6
- package/dist/components/organisms/FeaturedVideo/defaultProps.d.ts +0 -2
- package/dist/components/organisms/FiveArticlesGrid/FiveArticlesGrid.d.ts +0 -11
- package/dist/components/organisms/FiveArticlesGrid/FiveArticlesGrid.stories.d.ts +0 -10
- package/dist/components/organisms/FiveArticlesGrid/defaultProps.d.ts +0 -2
- package/dist/components/organisms/Footer/Footer.d.ts +0 -28
- package/dist/components/organisms/Footer/Footer.stories.d.ts +0 -14
- package/dist/components/organisms/Footer/defaultProps.d.ts +0 -8
- package/dist/components/organisms/GeneralSearchFilter/GeneralSearchFilter.d.ts +0 -31
- package/dist/components/organisms/GeneralSearchFilter/GeneralSearchFilter.stories.d.ts +0 -7
- package/dist/components/organisms/GeneralSearchFilter/defaultProps.d.ts +0 -2
- package/dist/components/organisms/GenericDetailSection/GenericDetailSection.d.ts +0 -12
- package/dist/components/organisms/GenericDetailSection/GenericDetailSection.stories.d.ts +0 -13
- package/dist/components/organisms/GenericDetailSection/defaultProps.d.ts +0 -5
- package/dist/components/organisms/Header/Header.d.ts +0 -30
- package/dist/components/organisms/Header/Header.stories.d.ts +0 -12
- package/dist/components/organisms/Header/components/MainMenu.d.ts +0 -12
- package/dist/components/organisms/Header/components/NestedMenu.d.ts +0 -11
- package/dist/components/organisms/Header/components/SearchMenu.d.ts +0 -45
- package/dist/components/organisms/Header/defaultProps.d.ts +0 -12
- package/dist/components/organisms/Header/types.d.ts +0 -13
- package/dist/components/organisms/Hero/Hero.d.ts +0 -44
- package/dist/components/organisms/Hero/Hero.stories.d.ts +0 -17
- package/dist/components/organisms/Hero/components/LinesOfIntent.d.ts +0 -7
- package/dist/components/organisms/Hero/components/PolygonImage.d.ts +0 -16
- package/dist/components/organisms/Hero/defaultProps.d.ts +0 -7
- package/dist/components/organisms/HeroArticle/HeroArticle.d.ts +0 -22
- package/dist/components/organisms/HeroArticle/HeroArticle.stories.d.ts +0 -10
- package/dist/components/organisms/HeroArticle/defaultProps.d.ts +0 -2
- package/dist/components/organisms/HeroCarousel/HeroCarousel.d.ts +0 -28
- package/dist/components/organisms/HeroCarousel/HeroCarousel.stories.d.ts +0 -11
- package/dist/components/organisms/HeroCarousel/animationVariants.d.ts +0 -177
- package/dist/components/organisms/HeroCarousel/components/HeroCardContent.d.ts +0 -17
- package/dist/components/organisms/HeroCarousel/components/HeroImage.d.ts +0 -15
- package/dist/components/organisms/HeroCarousel/components/LinesOfIntent.d.ts +0 -8
- package/dist/components/organisms/HeroCarousel/defaultProps.d.ts +0 -2
- package/dist/components/organisms/HeroCourses/HeroCourses.d.ts +0 -35
- package/dist/components/organisms/HeroCourses/HeroCourses.stories.d.ts +0 -14
- package/dist/components/organisms/HeroCourses/components/CourseTile.d.ts +0 -8
- package/dist/components/organisms/HeroCourses/components/CourseTileRanking.d.ts +0 -9
- package/dist/components/organisms/HeroCourses/components/CourseTileSelect.d.ts +0 -7
- package/dist/components/organisms/HeroCourses/components/tileLinkClickHandler.d.ts +0 -3
- package/dist/components/organisms/HeroCourses/defaultProps.d.ts +0 -43
- package/dist/components/organisms/HeroProfile/HeroProfile.d.ts +0 -28
- package/dist/components/organisms/HeroProfile/HeroProfile.stories.d.ts +0 -13
- package/dist/components/organisms/HeroProfile/defaultProps.d.ts +0 -5
- package/dist/components/organisms/ImageBlock/ImageBlock.d.ts +0 -10
- package/dist/components/organisms/ImageBlock/ImageBlock.stories.d.ts +0 -24
- package/dist/components/organisms/ImageBlock/defaultProps.d.ts +0 -3
- package/dist/components/organisms/ImageCarousel/ImageCarousel.d.ts +0 -10
- package/dist/components/organisms/ImageCarousel/ImageCarousel.stories.d.ts +0 -13
- package/dist/components/organisms/ImageCarousel/defaultProps.d.ts +0 -3
- package/dist/components/organisms/InPageNavigation/InPageNavigation.d.ts +0 -11
- package/dist/components/organisms/InPageNavigation/InPageNavigation.stories.d.ts +0 -11
- package/dist/components/organisms/InPageNavigation/defaultProps.d.ts +0 -2
- package/dist/components/organisms/IntroText/IntroText.d.ts +0 -22
- package/dist/components/organisms/IntroText/IntroText.stories.d.ts +0 -17
- package/dist/components/organisms/IntroText/defaultProps.d.ts +0 -2
- package/dist/components/organisms/LeadNewsArticles/LeadNewsArticles.d.ts +0 -12
- package/dist/components/organisms/LeadNewsArticles/LeadNewsArticles.stories.d.ts +0 -10
- package/dist/components/organisms/LeadNewsArticles/defaultProps.d.ts +0 -2
- package/dist/components/organisms/ListingFilterWrapper/ListingFilterWrapper.d.ts +0 -10
- package/dist/components/organisms/ListingFilterWrapper/ListingFilterWrapper.stories.d.ts +0 -6
- package/dist/components/organisms/ListingResults/ListingResults.d.ts +0 -19
- package/dist/components/organisms/ListingResults/ListingResults.stories.d.ts +0 -15
- package/dist/components/organisms/ListingResults/defaultProps.d.ts +0 -8
- package/dist/components/organisms/ListingResultsCount/ListingResultsCount.d.ts +0 -8
- package/dist/components/organisms/ListingResultsCount/ListingResultsCount.stories.d.ts +0 -15
- package/dist/components/organisms/LocationSection/LocationSection.d.ts +0 -18
- package/dist/components/organisms/LocationSection/LocationSection.stories.d.ts +0 -13
- package/dist/components/organisms/LocationSection/defaultProps.d.ts +0 -2
- package/dist/components/organisms/ModalCTA/ModalCTA.d.ts +0 -16
- package/dist/components/organisms/ModalCTA/ModalCTA.stories.d.ts +0 -12
- package/dist/components/organisms/ModalCTA/defaultProps.d.ts +0 -2
- package/dist/components/organisms/ModuleCardGroup/ModuleCardGroup.d.ts +0 -10
- package/dist/components/organisms/ModuleCardGroup/ModuleCardGroup.stories.d.ts +0 -14
- package/dist/components/organisms/ModuleCardGroup/defaultProps.d.ts +0 -2
- package/dist/components/organisms/NewsArticlesPromoBlock/NewsArticlesPromoBlock.d.ts +0 -12
- package/dist/components/organisms/NewsArticlesPromoBlock/NewsArticlesPromoBlock.stories.d.ts +0 -11
- package/dist/components/organisms/NewsArticlesPromoBlock/defaultProps.d.ts +0 -3
- package/dist/components/organisms/Pagination/Pagination.d.ts +0 -10
- package/dist/components/organisms/Pagination/Pagination.stories.d.ts +0 -12
- package/dist/components/organisms/ProfileCarousel/ProfileCarousel.stories.d.ts +0 -13
- package/dist/components/organisms/PromoBlock/PromoBlock.d.ts +0 -70
- package/dist/components/organisms/PromoBlock/PromoBlock.stories.d.ts +0 -36
- package/dist/components/organisms/PromoBlock/defaultProps.d.ts +0 -17
- package/dist/components/organisms/PromoBlockGrid/PromoBlockGrid.d.ts +0 -46
- package/dist/components/organisms/PromoBlockGrid/PromoBlockGrid.stories.d.ts +0 -17
- package/dist/components/organisms/PromoBlockGrid/defaultProps.d.ts +0 -3
- package/dist/components/organisms/QuoteBlock/QuoteBlock.d.ts +0 -20
- package/dist/components/organisms/QuoteBlock/QuoteBlock.stories.d.ts +0 -19
- package/dist/components/organisms/QuoteBlock/defaultProps.d.ts +0 -6
- package/dist/components/organisms/RelatedCourses/RelatedCourses.d.ts +0 -18
- package/dist/components/organisms/RelatedCourses/RelatedCourses.stories.d.ts +0 -16
- package/dist/components/organisms/RelatedCourses/defaultProps.d.ts +0 -2
- package/dist/components/organisms/ResearchStoryCarousel/ResearchStoryCarousel.d.ts +0 -17
- package/dist/components/organisms/ResearchStoryCarousel/ResearchStoryCarousel.stories.d.ts +0 -10
- package/dist/components/organisms/ResearchStoryCarousel/defaultProps.d.ts +0 -2
- package/dist/components/organisms/RichText/RichText.d.ts +0 -20
- package/dist/components/organisms/RichText/RichText.stories.d.ts +0 -18
- package/dist/components/organisms/RichText/defaultProps.d.ts +0 -13
- package/dist/components/organisms/ScholarshipCarousel/ScholarshipCarousel.d.ts +0 -13
- package/dist/components/organisms/ScholarshipCarousel/ScholarshipCarousel.stories.d.ts +0 -12
- package/dist/components/organisms/ScholarshipCarousel/defaultProps.d.ts +0 -2
- package/dist/components/organisms/ScrollableTable/ScrollableTable.d.ts +0 -12
- package/dist/components/organisms/ScrollableTable/ScrollableTable.stories.d.ts +0 -24
- package/dist/components/organisms/ScrollableTable/defaultProps.d.ts +0 -6
- package/dist/components/organisms/SearchCourses/SearchCourses.d.ts +0 -79
- package/dist/components/organisms/SearchCourses/SearchCourses.stories.d.ts +0 -20
- package/dist/components/organisms/SearchCourses/defaultProps.d.ts +0 -4
- package/dist/components/organisms/SidebarWrapper/SidebarWrapper.d.ts +0 -12
- package/dist/components/organisms/SidebarWrapper/SidebarWrapper.stories.d.ts +0 -15
- package/dist/components/organisms/SignPost/SignPost.d.ts +0 -35
- package/dist/components/organisms/SignPost/SignPost.stories.d.ts +0 -19
- package/dist/components/organisms/SignPost/defaultProps.d.ts +0 -3
- package/dist/components/organisms/SingleButton/SingleButton.d.ts +0 -13
- package/dist/components/organisms/SingleButton/SingleButton.stories.d.ts +0 -13
- package/dist/components/organisms/SingleButton/defaultProps.d.ts +0 -2
- package/dist/components/organisms/SkipToContent/SkipToContent.d.ts +0 -7
- package/dist/components/organisms/SkipToContent/SkipToContent.stories.d.ts +0 -15
- package/dist/components/organisms/StaffListingCarousel/StaffListingCarousel.d.ts +0 -20
- package/dist/components/organisms/StaffListingCarousel/StaffListingCarousel.stories.d.ts +0 -16
- package/dist/components/organisms/StaffListingCarousel/defaultProps.d.ts +0 -7
- package/dist/components/organisms/StandardListingFilter/StandardListingFilter.d.ts +0 -53
- package/dist/components/organisms/StandardListingFilter/StandardListingFilter.stories.d.ts +0 -7
- package/dist/components/organisms/StandardListingFilter/defaultProps.d.ts +0 -3
- package/dist/components/organisms/TabsBlock/TabsBlock.d.ts +0 -52
- package/dist/components/organisms/TabsBlock/TabsBlock.stories.d.ts +0 -24
- package/dist/components/organisms/TabsBlock/defaultProps.d.ts +0 -4
- package/dist/components/organisms/TextWithBackground/TextWithBackground.d.ts +0 -23
- package/dist/components/organisms/TextWithBackground/TextWithBackground.stories.d.ts +0 -22
- package/dist/components/organisms/TextWithBackground/defaultProps.d.ts +0 -4
- package/dist/components/organisms/TopicSelector/TopicSelector.d.ts +0 -17
- package/dist/components/organisms/TopicSelector/TopicSelector.stories.d.ts +0 -10
- package/dist/components/organisms/TopicSelector/defaultProps.d.ts +0 -2
- package/dist/components/organisms/TwoColumnWrapper/TwoColumnWrapper.d.ts +0 -12
- package/dist/components/organisms/TwoColumnWrapper/TwoColumnWrapper.stories.d.ts +0 -16
- package/dist/components/organisms/VideoCardComponent/VideoCardComponent.d.ts +0 -17
- package/dist/components/organisms/VideoCardComponent/VideoCardComponent.stories.d.ts +0 -6
- package/dist/components/organisms/VideoCardComponent/defaultProps.d.ts +0 -2
- package/dist/components/organisms/VideoEmbed/VideoEmbed.d.ts +0 -23
- package/dist/components/organisms/VideoEmbed/VideoEmbed.stories.d.ts +0 -17
- package/dist/components/organisms/VideoEmbed/defaultProps.d.ts +0 -2
- package/dist/hooks/mediaHook.d.ts +0 -1
- package/dist/hooks/useFocusTrap.d.ts +0 -5
- package/dist/hooks/useOnClickOutside.d.ts +0 -2
- package/dist/hooks/useScrollDirection.d.ts +0 -3
- package/dist/index.d.ts +0 -70
- package/dist/main.css +0 -1
- package/dist/main.js +0 -23
- package/dist/module.js +0 -23
- package/dist/themeProps.d.ts +0 -1
- package/dist/utils/ariaCarousel.d.ts +0 -29
- package/dist/utils/getFocusableTreeWalker.d.ts +0 -32
- package/dist/utils/util.d.ts +0 -3
package/README.md
CHANGED
|
@@ -1,111 +1,111 @@
|
|
|
1
|
-
# University of Birmingham Component Library
|
|
2
|
-
|
|
3
|
-
This is the frontend component library for the University of Birmingham website built using Storybook 7 and SASS.
|
|
4
|
-
|
|
5
|
-
## Contents
|
|
6
|
-
|
|
7
|
-
- [Installation and setup](#installation-and-setup)
|
|
8
|
-
- [Working locally on the project](#working-locally-on-the-project)
|
|
9
|
-
- [Creating Components](#creating-components)
|
|
10
|
-
- [Deploying changes to the public Storybook](#deploying-project-changes-to-the-public-storybook)
|
|
11
|
-
- [Publishing changes to the NPMJS package library](#publishing-changes-to-the-npmjs-package-library)
|
|
12
|
-
- [Using the NPMJS package library](#using-the-component-package-library)
|
|
13
|
-
|
|
14
|
-
## Installation and setup
|
|
15
|
-
|
|
16
|
-
### Compatibility
|
|
17
|
-
|
|
18
|
-
- **Node:** ^18.18.0
|
|
19
|
-
- **React:** ^18.3.1
|
|
20
|
-
|
|
21
|
-
### Setting up the project locally
|
|
22
|
-
|
|
23
|
-
1. Clone the repo from Github: `git clone git@github.com:uob-itservices/component-library.git`
|
|
24
|
-
2. Install NPM Node Modules by running `npm install` from the project root
|
|
25
|
-
|
|
26
|
-
## Working locally on the project
|
|
27
|
-
|
|
28
|
-
Run `npm run storybook` from the project root. This will run a new instance of [Storybook](https://storybook.js.org/) that can be accessed from `localhost:6006`.
|
|
29
|
-
|
|
30
|
-
Changes made locally are automatically compiled and the browser instance of Storybook will automaticaly refresh, hot-loading changes very quickly where possible.
|
|
31
|
-
|
|
32
|
-
## Creating components
|
|
33
|
-
|
|
34
|
-
Components should always be created within the `src/components` folder.
|
|
35
|
-
|
|
36
|
-
### Naming component folders
|
|
37
|
-
|
|
38
|
-
You can create a new folder within `src/components` that is based on the chosen name for your component. The format of this folder name, react component and story should always be PascalCase i.e. `MyNewComponent`. SASS files should always be camelCase i.e. `myNewComponent`
|
|
39
|
-
|
|
40
|
-
### Component file structure
|
|
41
|
-
|
|
42
|
-
Within the component folder you must create the following 3 files:
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
ComponentName
|
|
46
|
-
|_ {ComponentName}.tsx
|
|
47
|
-
|_ {ComponentName}.stories.ts
|
|
48
|
-
|_ {componentName}.scss
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
#### {ComponentName}.tsx
|
|
52
|
-
|
|
53
|
-
This file is where the Component Structure is defined.
|
|
54
|
-
|
|
55
|
-
#### {ComponentName}.stories.ts
|
|
56
|
-
|
|
57
|
-
This file allows developers to pass in mockup content to the component that will render within Storybook. More information is available in the Storybook docs [Storybook JS - Defining Stories](https://storybook.js.org/docs/react/writing-stories/introduction#defining-stories)
|
|
58
|
-
|
|
59
|
-
#### {componentName}.scss
|
|
60
|
-
|
|
61
|
-
This is where component styling is defined using SASS/CSS.
|
|
62
|
-
|
|
63
|
-
## Deploying project changes to the public Storybook
|
|
64
|
-
|
|
65
|
-
The visible Storybook for sharing changes is private and is accessed at [https://stunning-invention-1w42em5.pages.github.io/](https://stunning-invention-1w42em5.pages.github.io/) you will need to be a member of the uob-itservices GitHub organisation and have access to the repository.
|
|
66
|
-
|
|
67
|
-
This is automatically deployed and built when changes are pushed to the `develop` branch of the GitHub repository.
|
|
68
|
-
|
|
69
|
-
## Linting Before Committing
|
|
70
|
-
|
|
71
|
-
Before pushing a new commit to this component-library, please ensure that you run the following ES Lint command in your terminal:
|
|
72
|
-
|
|
73
|
-
`npm run lint`
|
|
74
|
-
|
|
75
|
-
This will highlight any linting issues that may arise when making file changes that will need to be fixed.
|
|
76
|
-
|
|
77
|
-
To adhere to the commit message best practice commitlint is used. More information on commit message linting can be found here at [https://github.com/conventional-changelog/commitlint/#what-is-commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)
|
|
78
|
-
|
|
79
|
-
## Publishing changes to the NPMJS package library
|
|
80
|
-
|
|
81
|
-
The repository will need publishing to the NPMJS package library [https://www.npmjs.com/package/@uob-web-and-digital/component-library](https://www.npmjs.com/package/@uob-web-and-digital/component-library) before it can be used in the UoB website.
|
|
82
|
-
|
|
83
|
-
This is a private package so a read-only NPM access token will need be created in order to install the package.
|
|
84
|
-
|
|
85
|
-
When the library in ready for a new release of the NPM package, you will need to increase the version number in the package.json and run a `npm install` to ensure the project gets updated with this version. After this you will need to create a pull request into the `develop` branch and then another pull request from the `develop` branch into `main`
|
|
86
|
-
|
|
87
|
-
As this is a manual process, ensure that the `main` branch of the repository is always in sync with the currently published package.
|
|
88
|
-
|
|
89
|
-
Releasing to the NPM registry are managed by GitHub Actions. You will need to create a new release and use the new release version as the tag. Once the release is published a GitHub Action will automatically run all the steps to publish the package on NPM.
|
|
90
|
-
|
|
91
|
-
## Using the component package library
|
|
92
|
-
|
|
93
|
-
In order to use the package you must have a NPM Access Token with read-only access to `@uob-web-and-digital/component-library`.
|
|
94
|
-
|
|
95
|
-
To install the package run `npm install @uob-web-and-digital/component-library`.
|
|
96
|
-
|
|
97
|
-
After installation you will need to add the following to your layout file;
|
|
98
|
-
|
|
99
|
-
```
|
|
100
|
-
import '@uob-web-and-digital/component-library/dist/main.css';
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
## Base64 fonts
|
|
104
|
-
|
|
105
|
-
Fonts are base64 encoded so they are not hosted on a third party.
|
|
106
|
-
|
|
107
|
-
To encode fonts to base64 you can run;
|
|
108
|
-
|
|
109
|
-
```
|
|
110
|
-
base64 -i Font.woff2 -o Font64txt
|
|
111
|
-
```
|
|
1
|
+
# University of Birmingham Component Library
|
|
2
|
+
|
|
3
|
+
This is the frontend component library for the University of Birmingham website built using Storybook 7 and SASS.
|
|
4
|
+
|
|
5
|
+
## Contents
|
|
6
|
+
|
|
7
|
+
- [Installation and setup](#installation-and-setup)
|
|
8
|
+
- [Working locally on the project](#working-locally-on-the-project)
|
|
9
|
+
- [Creating Components](#creating-components)
|
|
10
|
+
- [Deploying changes to the public Storybook](#deploying-project-changes-to-the-public-storybook)
|
|
11
|
+
- [Publishing changes to the NPMJS package library](#publishing-changes-to-the-npmjs-package-library)
|
|
12
|
+
- [Using the NPMJS package library](#using-the-component-package-library)
|
|
13
|
+
|
|
14
|
+
## Installation and setup
|
|
15
|
+
|
|
16
|
+
### Compatibility
|
|
17
|
+
|
|
18
|
+
- **Node:** ^18.18.0
|
|
19
|
+
- **React:** ^18.3.1
|
|
20
|
+
|
|
21
|
+
### Setting up the project locally
|
|
22
|
+
|
|
23
|
+
1. Clone the repo from Github: `git clone git@github.com:uob-itservices/component-library.git`
|
|
24
|
+
2. Install NPM Node Modules by running `npm install` from the project root
|
|
25
|
+
|
|
26
|
+
## Working locally on the project
|
|
27
|
+
|
|
28
|
+
Run `npm run storybook` from the project root. This will run a new instance of [Storybook](https://storybook.js.org/) that can be accessed from `localhost:6006`.
|
|
29
|
+
|
|
30
|
+
Changes made locally are automatically compiled and the browser instance of Storybook will automaticaly refresh, hot-loading changes very quickly where possible.
|
|
31
|
+
|
|
32
|
+
## Creating components
|
|
33
|
+
|
|
34
|
+
Components should always be created within the `src/components` folder.
|
|
35
|
+
|
|
36
|
+
### Naming component folders
|
|
37
|
+
|
|
38
|
+
You can create a new folder within `src/components` that is based on the chosen name for your component. The format of this folder name, react component and story should always be PascalCase i.e. `MyNewComponent`. SASS files should always be camelCase i.e. `myNewComponent`
|
|
39
|
+
|
|
40
|
+
### Component file structure
|
|
41
|
+
|
|
42
|
+
Within the component folder you must create the following 3 files:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
ComponentName
|
|
46
|
+
|_ {ComponentName}.tsx
|
|
47
|
+
|_ {ComponentName}.stories.ts
|
|
48
|
+
|_ {componentName}.scss
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
#### {ComponentName}.tsx
|
|
52
|
+
|
|
53
|
+
This file is where the Component Structure is defined.
|
|
54
|
+
|
|
55
|
+
#### {ComponentName}.stories.ts
|
|
56
|
+
|
|
57
|
+
This file allows developers to pass in mockup content to the component that will render within Storybook. More information is available in the Storybook docs [Storybook JS - Defining Stories](https://storybook.js.org/docs/react/writing-stories/introduction#defining-stories)
|
|
58
|
+
|
|
59
|
+
#### {componentName}.scss
|
|
60
|
+
|
|
61
|
+
This is where component styling is defined using SASS/CSS.
|
|
62
|
+
|
|
63
|
+
## Deploying project changes to the public Storybook
|
|
64
|
+
|
|
65
|
+
The visible Storybook for sharing changes is private and is accessed at [https://stunning-invention-1w42em5.pages.github.io/](https://stunning-invention-1w42em5.pages.github.io/) you will need to be a member of the uob-itservices GitHub organisation and have access to the repository.
|
|
66
|
+
|
|
67
|
+
This is automatically deployed and built when changes are pushed to the `develop` branch of the GitHub repository.
|
|
68
|
+
|
|
69
|
+
## Linting Before Committing
|
|
70
|
+
|
|
71
|
+
Before pushing a new commit to this component-library, please ensure that you run the following ES Lint command in your terminal:
|
|
72
|
+
|
|
73
|
+
`npm run lint`
|
|
74
|
+
|
|
75
|
+
This will highlight any linting issues that may arise when making file changes that will need to be fixed.
|
|
76
|
+
|
|
77
|
+
To adhere to the commit message best practice commitlint is used. More information on commit message linting can be found here at [https://github.com/conventional-changelog/commitlint/#what-is-commitlint](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)
|
|
78
|
+
|
|
79
|
+
## Publishing changes to the NPMJS package library
|
|
80
|
+
|
|
81
|
+
The repository will need publishing to the NPMJS package library [https://www.npmjs.com/package/@uob-web-and-digital/component-library](https://www.npmjs.com/package/@uob-web-and-digital/component-library) before it can be used in the UoB website.
|
|
82
|
+
|
|
83
|
+
This is a private package so a read-only NPM access token will need be created in order to install the package.
|
|
84
|
+
|
|
85
|
+
When the library in ready for a new release of the NPM package, you will need to increase the version number in the package.json and run a `npm install` to ensure the project gets updated with this version. After this you will need to create a pull request into the `develop` branch and then another pull request from the `develop` branch into `main`
|
|
86
|
+
|
|
87
|
+
As this is a manual process, ensure that the `main` branch of the repository is always in sync with the currently published package.
|
|
88
|
+
|
|
89
|
+
Releasing to the NPM registry are managed by GitHub Actions. You will need to create a new release and use the new release version as the tag. Once the release is published a GitHub Action will automatically run all the steps to publish the package on NPM.
|
|
90
|
+
|
|
91
|
+
## Using the component package library
|
|
92
|
+
|
|
93
|
+
In order to use the package you must have a NPM Access Token with read-only access to `@uob-web-and-digital/component-library`.
|
|
94
|
+
|
|
95
|
+
To install the package run `npm install @uob-web-and-digital/component-library`.
|
|
96
|
+
|
|
97
|
+
After installation you will need to add the following to your layout file;
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
import '@uob-web-and-digital/component-library/dist/main.css';
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
## Base64 fonts
|
|
104
|
+
|
|
105
|
+
Fonts are base64 encoded so they are not hosted on a third party.
|
|
106
|
+
|
|
107
|
+
To encode fonts to base64 you can run;
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
base64 -i Font.woff2 -o Font64txt
|
|
111
|
+
```
|
package/package.json
CHANGED
|
@@ -1,121 +1,121 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@uob-web-and-digital/component-library",
|
|
3
|
-
"version": "2.7.
|
|
4
|
-
"description": "A component library using React and Storybook.",
|
|
5
|
-
"repository": {
|
|
6
|
-
"type": "git",
|
|
7
|
-
"url": "git+https://github.com/uob-itservices/component-library.git"
|
|
8
|
-
},
|
|
9
|
-
"bugs": {
|
|
10
|
-
"url": "https://github.com/uob-itservices/component-library/issues"
|
|
11
|
-
},
|
|
12
|
-
"homepage": "https://github.com/uob-itservices/component-library#readme",
|
|
13
|
-
"author": {
|
|
14
|
-
"name": "University of Birmingham"
|
|
15
|
-
},
|
|
16
|
-
"source": "src/index.ts",
|
|
17
|
-
"main": "dist/main.js",
|
|
18
|
-
"module": "dist/module.js",
|
|
19
|
-
"types": "dist/index.d.ts",
|
|
20
|
-
"files": [
|
|
21
|
-
"dist"
|
|
22
|
-
],
|
|
23
|
-
"license": "",
|
|
24
|
-
"devDependencies": {
|
|
25
|
-
"@babel/preset-env": "^7.27.1",
|
|
26
|
-
"@babel/preset-react": "^7.27.1",
|
|
27
|
-
"@babel/preset-typescript": "^7.27.1",
|
|
28
|
-
"@commitlint/cli": "^19.8.1",
|
|
29
|
-
"@commitlint/config-conventional": "^19.8.1",
|
|
30
|
-
"@rollup/plugin-commonjs": "^28.0.6",
|
|
31
|
-
"@rollup/plugin-image": "^3.0.3",
|
|
32
|
-
"@rollup/plugin-node-resolve": "^16.0.1",
|
|
33
|
-
"@rollup/plugin-terser": "^0.4.4",
|
|
34
|
-
"@storybook/addon-a11y": "^8.6.14",
|
|
35
|
-
"@storybook/addon-essentials": "^8.6.14",
|
|
36
|
-
"@storybook/addon-interactions": "^8.6.14",
|
|
37
|
-
"@storybook/addon-links": "^8.6.14",
|
|
38
|
-
"@storybook/addon-onboarding": "^8.6.14",
|
|
39
|
-
"@storybook/addon-styling-webpack": "^1.0.0",
|
|
40
|
-
"@storybook/addon-webpack5-compiler-swc": "^3.0.0",
|
|
41
|
-
"@storybook/blocks": "^8.6.14",
|
|
42
|
-
"@storybook/react": "^8.6.14",
|
|
43
|
-
"@storybook/react-webpack5": "^8.6.14",
|
|
44
|
-
"@types/pluralize": "^0.0.33",
|
|
45
|
-
"@types/react": "^18.3.23",
|
|
46
|
-
"@types/sanitize-html": "^2.16.0",
|
|
47
|
-
"autoprefixer": "^10.4.21",
|
|
48
|
-
"chromatic": "^11.29.0",
|
|
49
|
-
"eslint": "^8.57.1",
|
|
50
|
-
"eslint-config-airbnb": "^19.0.4",
|
|
51
|
-
"eslint-config-airbnb-typescript": "^18.0.0",
|
|
52
|
-
"eslint-plugin-prettier": "^5.5.4",
|
|
53
|
-
"eslint-plugin-react": "^7.37.5",
|
|
54
|
-
"eslint-plugin-storybook": "^0.6.15",
|
|
55
|
-
"file-loader": "^6.2.0",
|
|
56
|
-
"husky": "^8.0.0",
|
|
57
|
-
"lint-staged": "^14.0.1",
|
|
58
|
-
"postcss": "^8.5.6",
|
|
59
|
-
"postcss-loader": "^7.3.4",
|
|
60
|
-
"react-dom": "^18.3.1",
|
|
61
|
-
"resolve-url-loader": "^5.0.0",
|
|
62
|
-
"rollup": "^4.1.4",
|
|
63
|
-
"rollup-plugin-dts": "^6.1.0",
|
|
64
|
-
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
65
|
-
"rollup-plugin-postcss": "^4.0.2",
|
|
66
|
-
"rollup-plugin-scss": "^4.0.0",
|
|
67
|
-
"rollup-plugin-typescript2": "^0.36.0",
|
|
68
|
-
"sass": "^1.68.0",
|
|
69
|
-
"sass-loader": "^13.3.2",
|
|
70
|
-
"storybook": "^8.6.14",
|
|
71
|
-
"storybook-addon-performance": "^0.17.1",
|
|
72
|
-
"style-loader": "^3.3.3",
|
|
73
|
-
"stylelint": "^15.11.0",
|
|
74
|
-
"stylelint-config-idiomatic-order": "^9.0.0",
|
|
75
|
-
"stylelint-config-prettier-scss": "^1.0.0",
|
|
76
|
-
"stylelint-config-recommended": "^13.0.0",
|
|
77
|
-
"stylelint-config-recommended-scss": "^13.0.0",
|
|
78
|
-
"stylelint-config-sass-guidelines": "^10.0.0",
|
|
79
|
-
"stylelint-config-standard": "^34.0.0",
|
|
80
|
-
"stylelint-config-standard-scss": "^11.0.0",
|
|
81
|
-
"typescript": "^5.2.2"
|
|
82
|
-
},
|
|
83
|
-
"dependencies": {
|
|
84
|
-
"@storybook/addon-docs": "^8.6.14",
|
|
85
|
-
"@storybook/testing-library": "^0.2.2",
|
|
86
|
-
"clsx": "^2.1.1",
|
|
87
|
-
"embla-carousel-class-names": "^8.6.0",
|
|
88
|
-
"embla-carousel-react": "^8.6.0",
|
|
89
|
-
"focus-trap-react": "^10.3.1",
|
|
90
|
-
"framer-motion": "^12.23.12",
|
|
91
|
-
"pluralize": "^8.0.0",
|
|
92
|
-
"react": "^18.3.1"
|
|
93
|
-
},
|
|
94
|
-
"overrides": {
|
|
95
|
-
"stylelint-config-idiomatic-order": {
|
|
96
|
-
"stylelint": "^15.11.0"
|
|
97
|
-
}
|
|
98
|
-
},
|
|
99
|
-
"scripts": {
|
|
100
|
-
"storybook": "storybook dev -p 6006",
|
|
101
|
-
"build-storybook": "storybook build",
|
|
102
|
-
"lint": "eslint \"./src/**/*.{js,jsx,ts,tsx}\" --max-warnings 0",
|
|
103
|
-
"lint-css": "stylelint --allow-empty-input '**/*.{css,scss}'",
|
|
104
|
-
"css-fix": "stylelint --fix '**/*.{css,scss}'",
|
|
105
|
-
"pretty": "prettier --write './**/*.{ts,tsx,scss,css,json,md,mdx}'",
|
|
106
|
-
"prepare": "husky install",
|
|
107
|
-
"pre-commit": "lint-staged",
|
|
108
|
-
"build-package": "rollup -c --bundleConfigAsCjs",
|
|
109
|
-
"chromatic": "npx chromatic --project-token=772c1293b28c"
|
|
110
|
-
},
|
|
111
|
-
"lint-staged": {
|
|
112
|
-
"src/**/*.{js,jsx,ts,tsx}": [
|
|
113
|
-
"npm run pretty",
|
|
114
|
-
"npm run lint"
|
|
115
|
-
],
|
|
116
|
-
"src/**/*.{css,scss}": [
|
|
117
|
-
"npm run pretty",
|
|
118
|
-
"npm run lint-css"
|
|
119
|
-
]
|
|
120
|
-
}
|
|
121
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "@uob-web-and-digital/component-library",
|
|
3
|
+
"version": "2.7.2",
|
|
4
|
+
"description": "A component library using React and Storybook.",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/uob-itservices/component-library.git"
|
|
8
|
+
},
|
|
9
|
+
"bugs": {
|
|
10
|
+
"url": "https://github.com/uob-itservices/component-library/issues"
|
|
11
|
+
},
|
|
12
|
+
"homepage": "https://github.com/uob-itservices/component-library#readme",
|
|
13
|
+
"author": {
|
|
14
|
+
"name": "University of Birmingham"
|
|
15
|
+
},
|
|
16
|
+
"source": "src/index.ts",
|
|
17
|
+
"main": "dist/main.js",
|
|
18
|
+
"module": "dist/module.js",
|
|
19
|
+
"types": "dist/index.d.ts",
|
|
20
|
+
"files": [
|
|
21
|
+
"dist"
|
|
22
|
+
],
|
|
23
|
+
"license": "",
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"@babel/preset-env": "^7.27.1",
|
|
26
|
+
"@babel/preset-react": "^7.27.1",
|
|
27
|
+
"@babel/preset-typescript": "^7.27.1",
|
|
28
|
+
"@commitlint/cli": "^19.8.1",
|
|
29
|
+
"@commitlint/config-conventional": "^19.8.1",
|
|
30
|
+
"@rollup/plugin-commonjs": "^28.0.6",
|
|
31
|
+
"@rollup/plugin-image": "^3.0.3",
|
|
32
|
+
"@rollup/plugin-node-resolve": "^16.0.1",
|
|
33
|
+
"@rollup/plugin-terser": "^0.4.4",
|
|
34
|
+
"@storybook/addon-a11y": "^8.6.14",
|
|
35
|
+
"@storybook/addon-essentials": "^8.6.14",
|
|
36
|
+
"@storybook/addon-interactions": "^8.6.14",
|
|
37
|
+
"@storybook/addon-links": "^8.6.14",
|
|
38
|
+
"@storybook/addon-onboarding": "^8.6.14",
|
|
39
|
+
"@storybook/addon-styling-webpack": "^1.0.0",
|
|
40
|
+
"@storybook/addon-webpack5-compiler-swc": "^3.0.0",
|
|
41
|
+
"@storybook/blocks": "^8.6.14",
|
|
42
|
+
"@storybook/react": "^8.6.14",
|
|
43
|
+
"@storybook/react-webpack5": "^8.6.14",
|
|
44
|
+
"@types/pluralize": "^0.0.33",
|
|
45
|
+
"@types/react": "^18.3.23",
|
|
46
|
+
"@types/sanitize-html": "^2.16.0",
|
|
47
|
+
"autoprefixer": "^10.4.21",
|
|
48
|
+
"chromatic": "^11.29.0",
|
|
49
|
+
"eslint": "^8.57.1",
|
|
50
|
+
"eslint-config-airbnb": "^19.0.4",
|
|
51
|
+
"eslint-config-airbnb-typescript": "^18.0.0",
|
|
52
|
+
"eslint-plugin-prettier": "^5.5.4",
|
|
53
|
+
"eslint-plugin-react": "^7.37.5",
|
|
54
|
+
"eslint-plugin-storybook": "^0.6.15",
|
|
55
|
+
"file-loader": "^6.2.0",
|
|
56
|
+
"husky": "^8.0.0",
|
|
57
|
+
"lint-staged": "^14.0.1",
|
|
58
|
+
"postcss": "^8.5.6",
|
|
59
|
+
"postcss-loader": "^7.3.4",
|
|
60
|
+
"react-dom": "^18.3.1",
|
|
61
|
+
"resolve-url-loader": "^5.0.0",
|
|
62
|
+
"rollup": "^4.1.4",
|
|
63
|
+
"rollup-plugin-dts": "^6.1.0",
|
|
64
|
+
"rollup-plugin-peer-deps-external": "^2.2.4",
|
|
65
|
+
"rollup-plugin-postcss": "^4.0.2",
|
|
66
|
+
"rollup-plugin-scss": "^4.0.0",
|
|
67
|
+
"rollup-plugin-typescript2": "^0.36.0",
|
|
68
|
+
"sass": "^1.68.0",
|
|
69
|
+
"sass-loader": "^13.3.2",
|
|
70
|
+
"storybook": "^8.6.14",
|
|
71
|
+
"storybook-addon-performance": "^0.17.1",
|
|
72
|
+
"style-loader": "^3.3.3",
|
|
73
|
+
"stylelint": "^15.11.0",
|
|
74
|
+
"stylelint-config-idiomatic-order": "^9.0.0",
|
|
75
|
+
"stylelint-config-prettier-scss": "^1.0.0",
|
|
76
|
+
"stylelint-config-recommended": "^13.0.0",
|
|
77
|
+
"stylelint-config-recommended-scss": "^13.0.0",
|
|
78
|
+
"stylelint-config-sass-guidelines": "^10.0.0",
|
|
79
|
+
"stylelint-config-standard": "^34.0.0",
|
|
80
|
+
"stylelint-config-standard-scss": "^11.0.0",
|
|
81
|
+
"typescript": "^5.2.2"
|
|
82
|
+
},
|
|
83
|
+
"dependencies": {
|
|
84
|
+
"@storybook/addon-docs": "^8.6.14",
|
|
85
|
+
"@storybook/testing-library": "^0.2.2",
|
|
86
|
+
"clsx": "^2.1.1",
|
|
87
|
+
"embla-carousel-class-names": "^8.6.0",
|
|
88
|
+
"embla-carousel-react": "^8.6.0",
|
|
89
|
+
"focus-trap-react": "^10.3.1",
|
|
90
|
+
"framer-motion": "^12.23.12",
|
|
91
|
+
"pluralize": "^8.0.0",
|
|
92
|
+
"react": "^18.3.1"
|
|
93
|
+
},
|
|
94
|
+
"overrides": {
|
|
95
|
+
"stylelint-config-idiomatic-order": {
|
|
96
|
+
"stylelint": "^15.11.0"
|
|
97
|
+
}
|
|
98
|
+
},
|
|
99
|
+
"scripts": {
|
|
100
|
+
"storybook": "storybook dev -p 6006",
|
|
101
|
+
"build-storybook": "storybook build",
|
|
102
|
+
"lint": "eslint \"./src/**/*.{js,jsx,ts,tsx}\" --max-warnings 0",
|
|
103
|
+
"lint-css": "stylelint --allow-empty-input '**/*.{css,scss}'",
|
|
104
|
+
"css-fix": "stylelint --fix '**/*.{css,scss}'",
|
|
105
|
+
"pretty": "prettier --write './**/*.{ts,tsx,scss,css,json,md,mdx}'",
|
|
106
|
+
"prepare": "husky install",
|
|
107
|
+
"pre-commit": "lint-staged",
|
|
108
|
+
"build-package": "rollup -c --bundleConfigAsCjs",
|
|
109
|
+
"chromatic": "npx chromatic --project-token=772c1293b28c"
|
|
110
|
+
},
|
|
111
|
+
"lint-staged": {
|
|
112
|
+
"src/**/*.{js,jsx,ts,tsx}": [
|
|
113
|
+
"npm run pretty",
|
|
114
|
+
"npm run lint"
|
|
115
|
+
],
|
|
116
|
+
"src/**/*.{css,scss}": [
|
|
117
|
+
"npm run pretty",
|
|
118
|
+
"npm run lint-css"
|
|
119
|
+
]
|
|
120
|
+
}
|
|
121
|
+
}
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import './breadcrumbLink.scss';
|
|
4
|
-
export interface BreadcrumbLinkProps {
|
|
5
|
-
theme: ThemeProps;
|
|
6
|
-
inverse?: boolean;
|
|
7
|
-
url: string;
|
|
8
|
-
title: string;
|
|
9
|
-
}
|
|
10
|
-
export default function BreadcrumbLink({ theme, inverse, url, title }: BreadcrumbLinkProps): ReactElement;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { StoryObj } from '@storybook/react';
|
|
2
|
-
import BreadcrumbLink from './BreadcrumbLink';
|
|
3
|
-
declare const meta: {
|
|
4
|
-
title: string;
|
|
5
|
-
component: typeof BreadcrumbLink;
|
|
6
|
-
tags: string[];
|
|
7
|
-
};
|
|
8
|
-
export default meta;
|
|
9
|
-
type Story = StoryObj<typeof meta>;
|
|
10
|
-
export declare const Dark: Story;
|
|
11
|
-
export declare const Light: Story;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import './calendarGraphic.scss';
|
|
4
|
-
export interface CalendarGraphicProps {
|
|
5
|
-
theme: ThemeProps;
|
|
6
|
-
status: 'Upcoming' | 'Recorded' | 'More';
|
|
7
|
-
day?: string;
|
|
8
|
-
month?: string;
|
|
9
|
-
}
|
|
10
|
-
export default function CalendarGraphic({ theme, status, day, month }: CalendarGraphicProps): ReactElement;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import type { StoryObj } from '@storybook/react';
|
|
2
|
-
import CalendarGraphic from './CalendarGraphic';
|
|
3
|
-
declare const meta: {
|
|
4
|
-
title: string;
|
|
5
|
-
component: typeof CalendarGraphic;
|
|
6
|
-
tags: string[];
|
|
7
|
-
};
|
|
8
|
-
export default meta;
|
|
9
|
-
type Story = StoryObj<typeof meta>;
|
|
10
|
-
export declare const CalendarGraphicUpcomingEvent: Story;
|
|
11
|
-
export declare const CalendarGraphicRecordedEvent: Story;
|
|
12
|
-
export declare const CalendarGraphicMoreDatesEvent: Story;
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import { ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import './campusSelectorLink.scss';
|
|
4
|
-
export interface CampusSelectorLinkProps {
|
|
5
|
-
/**
|
|
6
|
-
* The theme to use
|
|
7
|
-
*/
|
|
8
|
-
theme: ThemeProps;
|
|
9
|
-
/**
|
|
10
|
-
* Whether to inverse the colours
|
|
11
|
-
*/
|
|
12
|
-
label: string;
|
|
13
|
-
url: string;
|
|
14
|
-
externalLink?: boolean;
|
|
15
|
-
active?: boolean;
|
|
16
|
-
}
|
|
17
|
-
export default function CampusSelectorLink({ theme, label, url, externalLink, active }: CampusSelectorLinkProps): ReactElement;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { StoryObj } from '@storybook/react';
|
|
2
|
-
import CampusSelectorLink from './CampusSelectorLink';
|
|
3
|
-
declare const meta: {
|
|
4
|
-
title: string;
|
|
5
|
-
component: typeof CampusSelectorLink;
|
|
6
|
-
tags: string[];
|
|
7
|
-
};
|
|
8
|
-
export default meta;
|
|
9
|
-
type Story = StoryObj<typeof CampusSelectorLink>;
|
|
10
|
-
export declare const Default: Story;
|
|
11
|
-
export declare const Active: Story;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { ReactElement, ChangeEvent } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import './checkbox.scss';
|
|
4
|
-
export interface CheckboxProps {
|
|
5
|
-
theme: ThemeProps;
|
|
6
|
-
name: string;
|
|
7
|
-
value: string;
|
|
8
|
-
defaultChecked?: boolean;
|
|
9
|
-
label: string;
|
|
10
|
-
id: string;
|
|
11
|
-
onChange?: (e: ChangeEvent) => void;
|
|
12
|
-
}
|
|
13
|
-
export default function Checkbox({ theme, name, defaultChecked, label, id, value, onChange }: CheckboxProps): ReactElement;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import type { StoryObj } from '@storybook/react';
|
|
2
|
-
import Checkbox from './Checkbox';
|
|
3
|
-
declare const meta: {
|
|
4
|
-
title: string;
|
|
5
|
-
component: typeof Checkbox;
|
|
6
|
-
tags: string[];
|
|
7
|
-
};
|
|
8
|
-
export default meta;
|
|
9
|
-
type Story = StoryObj<typeof Checkbox>;
|
|
10
|
-
export declare const Default: Story;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import { IconType } from '../Icons/Icons';
|
|
4
|
-
import './courseDeliveryPill.scss';
|
|
5
|
-
export interface CourseDeliveryPillProps {
|
|
6
|
-
theme: ThemeProps;
|
|
7
|
-
label: string;
|
|
8
|
-
iconType?: IconType;
|
|
9
|
-
}
|
|
10
|
-
export default function CourseDeliveryPill({ theme, label, iconType }: CourseDeliveryPillProps): ReactElement;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import type { StoryObj } from '@storybook/react';
|
|
2
|
-
import CourseDeliveryPill from './CourseDeliveryPill';
|
|
3
|
-
declare const meta: {
|
|
4
|
-
title: string;
|
|
5
|
-
component: typeof CourseDeliveryPill;
|
|
6
|
-
tags: string[];
|
|
7
|
-
};
|
|
8
|
-
export default meta;
|
|
9
|
-
type Story = StoryObj<typeof CourseDeliveryPill>;
|
|
10
|
-
export declare const Default: Story;
|
|
11
|
-
export declare const NoIcon: Story;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import { IconType } from '../Icons/Icons';
|
|
4
|
-
import './courseIcon.scss';
|
|
5
|
-
export interface CourseIconProps {
|
|
6
|
-
theme: ThemeProps;
|
|
7
|
-
inverse?: boolean;
|
|
8
|
-
icon: IconType;
|
|
9
|
-
backgroundColor?: 'pale' | 'dark';
|
|
10
|
-
}
|
|
11
|
-
export default function CourseIcon({ theme, inverse, icon, backgroundColor }: CourseIconProps): ReactElement;
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { ChangeEvent, ReactElement } from 'react';
|
|
2
|
-
import { ThemeProps } from '../../../themeProps';
|
|
3
|
-
import './dateInput.scss';
|
|
4
|
-
export interface DateInputProps {
|
|
5
|
-
theme: ThemeProps;
|
|
6
|
-
name: string;
|
|
7
|
-
id: string;
|
|
8
|
-
label: string;
|
|
9
|
-
defaultValue?: string;
|
|
10
|
-
onChange?: (e: ChangeEvent) => void;
|
|
11
|
-
}
|
|
12
|
-
export default function DateInput({ theme, name, id, label, defaultValue, onChange }: DateInputProps): ReactElement;
|