Title

Global

Members

# constant FirstMenuContainer

withTracker connects Meteor data to React components. https://guide.meteor.com/react.html#using-withTracker

View Source ui/components/shared/FirstMenu.tsx, line 37

# constant LandingHomeContainer

withTracker connects Meteor data to React components. https://guide.meteor.com/react.html#using-withTracker

View Source ui/pages/landing/LandingHomePage.tsx, line 27

# constant makeSampleCourseSlugArray

Creates an array of defined course slugs.

View Source api/course/SampleCourses.ts, line 44

# constant makeSamplePageInterestInfoArray

Creates an array of PageInterestInfo

View Source api/page-tracking/SamplePageInterestsDailySnapshots.ts, line 17

# constant schema

Schema for the form that controls sending email.

View Source ui/components/admin/analytics/newsletter/AdminAnalyticsNewsletterWidget.tsx, line 20

Methods

# AdminDataModelAcademicPlansPage()

The AcademicPlan data model page.

View Source ui/pages/admin/AdminDataModelAcademicPlansPage.tsx, line 54

# AdminModerationPage()

A simple static component to render some text for the landing page.

View Source ui/pages/admin/AdminModerationPage.tsx, line 8

# AdminPageMenuWidget()

A simple static component to render some text for the landing page.

View Source ui/components/admin/AdminPageMenuWidget.tsx, line 7

# AdminProtectedRoute({)

AdminProtectedRoute (see React Router v4 sample) Checks for Meteor login and admin role before routing to the requested page, otherwise goes to signin page.

Parameters:
Name Type Description
{ any

component: Component, ...rest }

View Source ui/layouts/App.tsx, line 58

# App()

Top-level layout component for this application. Called in imports/startup/client/startup.tsx.

View Source ui/layouts/App.tsx, line 26

# CompletedVerificationsWidget(completedVerifications, username) → {Segment}

Component that naively displays a supplied array of IVerificationRequests and the UI for users to handle them. The parent component is expected to handle permissions and filtering (role and status are not checked in this component).

Parameters:
Name Type Description
completedVerifications Array.<IVerificationRequest>
username string

Current user's username. Used primarily for getting name of user when making changes to records.

View Source ui/components/shared/verification/CompletedVerificationsWidget.tsx, line 46

Segment

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 43

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 48

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedbackInstancesPage.tsx, line 43

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedsPage.tsx, line 45

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelHelpMessagesPage.tsx, line 41

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 52

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 42

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 47

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 46

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 52

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelPlanChoicesPage.tsx, line 41

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 43

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 38

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 44

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 44

# descriptionPairs(item)

Returns an array of Description pairs used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/faculty/FacultyManageOpportunitiesPage.tsx, line 29

# EventVerificationsWidget(eventOpportunities) → {Segment}

This component naively displays a supplied array of IEventOpportunities and a form to verify individual students. The parent component is expected to handle permissions and filtering (eventDate property is not checked in this component).

Parameters:
Name Type Description
eventOpportunities Array.<IEventOpportunity>

An array of IOpportunities where eventDate exists

View Source ui/components/shared/verification/EventVerificationsWidget.tsx, line 14

Segment

# ExplorerMultipleItemsWidget()

Process to build a new Card Explorer Widget Refer to this documentation if we're building a new Card Explorer Widget for a new type if you simply need to understand how building the Card Explorer Widget is abstracted.

  1. Define a title in @getHeaderTitle() under a new case statement
  2. Build a function to get the item count for that type
  3. Call the function from #2 in @getHeaderCount() under a new case statement
  4. Build a function that calculates if the user needs to add a particular item type to their plan (returns boolean)
  5. Build a render message(s) in @buildNoItemsMessage('noItemsType') that tells the user that they need to add item type to their plan for each item type that they need
  6. Call the function(s) from #4 in @noItems() under a new case statement for each item type
  7. For each Card Explorer PAGE, call @noItems('noItemsType') ? this.buildNoItemsMessage('noItemsType') : '' for each of the noItemsType from #5 & #6. If there is more than one item type, this should be wrapped in a <React.Fragment> ##Steps #1 through #7 builds the HEADER for the Card Explorer page.##
  8. Build the main function and any necessary helper functions to get the items to map over for that Card Explorer page.
  9. Call the main function from #8 under @getItems() under a new case statement for that page.
  10. Add a new typing for the type under ICardExplorerWidgetProps for the Card Explorer Page being built. This string should be the same as the END string of the url. (i.e. /student/:username/explorer/career-goals. In this case, career-goals is the type.)
  11. In the render() function, build the Card Explorer Card by mapping over items.

View Source ui/components/shared/explorer/multiple-items/ExplorerMultipleItemsWidget.tsx, line 60

# ExplorerUsersWidget(userProfile, isActive, handleClose) → {Dimmer}

This component is a placeholder in case an individual explorer is created for users. It offers little more than the UserProfileCard, with the most notable differences being a full website being displayed instead of a button and the IBaseProfile.motivation field being displayed if it exists.

Parameters:
Name Type Description
userProfile IBaseProfile

User profile to be displayed

isActive boolean

This component expects the parent to manage state

handleClose function

Handler to close component (dimmer) when clicking outside of the component

View Source ui/components/shared/community-users/ExplorerUsersWidget.tsx, line 19

Dimmer

# FacultyPageAboutMeWidget()

The Faculty About Me Widget shows basic information of the specified user.

View Source ui/components/faculty/home/FacultyPageAboutMeWidget.tsx, line 14

The LandingFooter appears at the bottom of every page. Rendered by the App Layout component.

View Source ui/components/Footer.tsx, line 5

# getCourseNumber(courseSlug) → {string}

Returns the number portion of the getCourseSlug.

Parameters:
Name Type Description
courseSlug

the course slug.

View Source api/course/CourseUtilities.ts, line 156

string

# getPlanCount(planChoice) → {number}

Returns the count of the given planChoice.

Parameters:
Name Type Description
planChoice string

the planChoice

View Source api/degree-plan/PlanChoiceUtilities.ts, line 22

the count value of the planChoice, or 0 if none.

number

# getRandomCourseSlug(deptLength, min, max) → {string}

Returns a random course slug for a random department.

Parameters:
Name Type Description
deptLength number

the length of the department string, defaults to 3.

min number

the minimum course number, (optional) defaults to 100.

max number

the maximum course number, (optional) defaults to 800.

View Source api/course/CourseUtilities.ts, line 191

string

# getRandomCourseSlugForDept(dept, min, max) → {string}

Returns a random course slug for the given department.

Parameters:
Name Type Description
dept string

the department

min number

the minimum course number, (optional) defaults to 100.

max number

the maximum course number, (optional) defaults to 800.

View Source api/course/CourseUtilities.ts, line 178

string

# getRandomDepartment(length) → {string}

Returns a random department string.

Parameters:
Name Type Description
length number

View Source api/course/CourseUtilities.ts, line 164

string

# getSimpleChoiceNumber(courseSlug) → {string}

Returns the number portion of the getCourseSlug.

Parameters:
Name Type Description
courseSlug

the course slug.

View Source api/degree-plan/PlanChoiceUtilities.ts, line 170

string

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 69

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 66

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedbackInstancesPage.tsx, line 63

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedsPage.tsx, line 87

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelHelpMessagesPage.tsx, line 56

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 68

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 56

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 66

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 71

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 68

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelPlanChoicesPage.tsx, line 54

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 73

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 52

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 66

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 70

# itemTitle(item)

Returns the ReactNode used in the ListCollectionWidget. By default we indicate if the item is retired.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/faculty/FacultyManageOpportunitiesPage.tsx, line 47

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCourseInstancesPage.tsx, line 59

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelCoursesPage.tsx, line 61

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedbackInstancesPage.tsx, line 54

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelFeedsPage.tsx, line 82

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelHelpMessagesPage.tsx, line 51

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestTypesPage.tsx, line 63

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelInterestsPage.tsx, line 51

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunitiesPage.tsx, line 61

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityInstancesPage.tsx, line 61

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelOpportunityTypesPage.tsx, line 63

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelPlanChoicesPage.tsx, line 49

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelReviewsPage.tsx, line 68

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelSlugsPage.tsx, line 47

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelTeasersPage.tsx, line 57

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/admin/AdminDataModelVerificationRequestsPage.tsx, line 59

# itemTitleString(item)

Returns the title string for the item. Used in the ListCollectionWidget.

Parameters:
Name Type Description
item

an item from the collection.

View Source ui/pages/faculty/FacultyManageOpportunitiesPage.tsx, line 42

# LandingHomePage()

A simple static component to render some text for the landing page.

View Source ui/pages/landing/LandingHomePage.tsx, line 17

# LandingNavBar()

LandingNavBar rendered on each of the landing pages.

View Source ui/components/landing/LandingNavBar.tsx, line 14

# makeSampleCareerGoal() → {string}

Defines a sample CareerGoal.

View Source api/career/SampleCareerGoals.ts, line 12

the id of the defined CareerGoal.

string

# makeSampleCareerGoalArray(num) → {Array.<string>}

Returns an array of defined CareerGoal ids.

Parameters:
Name Type Description
num

the number of CareerGoals to define.

View Source api/career/SampleCareerGoals.ts, line 24

An array of CareerGoal ids.

Array.<string>

# makeSampleCareerGoalSlugArray(num) → {Array.<string>}

Returns an array of defined CareerGoal slugs.

Parameters:
Name Type Description
num

the number of CareerGoals to define.

View Source api/career/SampleCareerGoals.ts, line 36

An array of defined CareerGoal slugs.

Array.<string>

# makeSampleInterestArray(numInterests) → {Array.<string>}

Returns an array of interestIDs.

Parameters:
Name Type Description
numInterests number

the number of interestIDs. Defaults to 1.

View Source api/interest/SampleInterests.ts, line 39

Array.<string>

# makeSampleInterestSlugArray(numInterests) → {Array.<string>}

Returns an array of defined Interest slugs.

Parameters:
Name Type Description
numInterests

the number of Interests to define. Defaults to 1.

View Source api/interest/SampleInterests.ts, line 51

An array of defined Interest Slugs.

Array.<string>

# makeSampleOpportunitySlugArray(sponsor, num)

Creates an array of defined opportunity slugs.

Parameters:
Name Type Description
sponsor

the sponsor of the opportunity.

num

the number of opportunities to define. Defaults to 1.

View Source api/opportunity/SampleOpportunities.ts, line 45

An array of defined opportunity slugs.

# makeSamplePageInterestInfo(maxViews)

Creates a PageInterestInfo object of a unique slug and views

Parameters:
Name Type Description
maxViews

(inclusive) the maximum number of views randomly generated

View Source api/page-tracking/SamplePageInterestsDailySnapshots.ts, line 8

# makeSampleUserArray(num, role)

Returns an array of defined usernames.

Parameters:
Name Type Description
num

the number of user to define. Defaults to 1.

role

the Role of the users. Defaults to STUDENT.

View Source api/user/SampleUsers.ts, line 71

an array of defined usernames.

# NotAuthorizedPage()

Render a Not Found page if the user enters a URL that doesn't match any route.

View Source ui/pages/NotAuthorizedPage.tsx, line 6

# NotFoundPage()

Render a Not Found page if the user enters a URL that doesn't match any route.

View Source ui/pages/NotFoundPage.tsx, line 5

# PendingVerificationsWidget(pendingVerifications) → {Segment}

Component that naively displays a supplied array of IVerificationRequests and the UI for users to handle them. The parent component is expected to handle permissions and filtering (role and status are not checked in this component).

Parameters:
Name Type Description
pendingVerifications Array.<IVerificationRequest>

View Source ui/components/shared/verification/PendingVerificationsWidget.tsx, line 15

Segment

# processBulkStarCsvData(csvData)

Processes STAR CSV data.

Parameters:
Name Type Description
csvData
Deprecated:
  • Yes

View Source api/star/StarProcessor.ts, line 183

# ProtectedRoute({)

ProtectedRoute (see React Router v4 sample) Checks for Meteor login before routing to the requested page, otherwise goes to signin page.

Parameters:
Name Type Description
{ any

component: Component, ...rest }

View Source ui/layouts/App.tsx, line 45

# removeEmptyYearsRaw(coursesPerAcademicTerm) → {Array.<number>}

Removes the empty years from coursesPerAcademicTerm.

Parameters:
Name Type Description
coursesPerAcademicTerm Array.<number>

View Source api/degree-plan/AcademicPlanUtilities.ts, line 196

Array.<number>

# removeYearFromPlanRaw(coursesPerAcademicTerm, yearNum) → {Array.<number>}

Removes the year from coursesPerAcademicTerm if the coursesPerAcademicTerm are all 0.

Parameters:
Name Type Description
coursesPerAcademicTerm Array.<number>
yearNum number

View Source api/degree-plan/AcademicPlanUtilities.ts, line 182

Array.<number>

# sendEmail(to, cc, from, subject, templateData)

Email sender to distribute RadGrad newsletter. Utilizes SSR to compile and render HTML/CSS code within the email.

Parameters:
Name Type Description
to

The recipient.

cc

The cc recipients.

from

The sender.

subject

The email subject line.

templateData

Custom data to be rendered in the email template. SSR is used to compile and render the final content.

View Source api/analytic/Email.ts, line 16

# SigninPage()

SigninPage page overrides the form’s submit event and call Meteor’s loginWithPassword(). Authentication errors modify the component’s state to be displayed

View Source ui/pages/SigninPage.tsx, line 13

# SignoutPage()

After the user clicks the "SignoutPage" link in the NavBar, log them out and display this page.

View Source ui/pages/SignoutPage.tsx, line 7

# validateCourseSlugFormat(courseSlug) → {boolean}

Checks the format of the getCourseSlug. Does not check to see if the slug is defined. Valid course slugs have the format _.

Parameters:
Name Type Description
courseSlug

the slug to check.

View Source api/course/CourseUtilities.ts, line 136

Meteor.Error if the slug doesn't have the right format.

boolean