react-component-atlas.md

React Component Atlas

This is a high-level overview of the structure of the React component tree that this package creates. It's intended not to be comprehensive, but to give you an idea of where to find specific bits of functionality.

<RootController>

Root of the entire, unified React component tree. Mostly responsible for registering pane items, status bar tiles, workspace commands, and managing dialog box state. Action methods that are shared across broad swaths of the component tree.

<GitTabItem> <GitTabContainer> <GitTabController> <GitTabView>

The "Git" tab that appears in the right dock (by default).

<StagingView>

The lists of unstaged changes, staged changes, and merge conflicts.

<CommitController> <CommitView>

The commit message editor, submit button, and co-author selection controls.

<RecentCommitsController> <RecentCommitsView> <RecentCommitView>

List of most recent commits on the current branch.

<GitHubTabItem> <GitHubTabContainer> <GitHubTabController> <GitHubTabView>

The "GitHub" tab that appears in the right dock (by default).

<RemoteSelectorView>

Shown if the current repository has more than one remote that's identified as a github.com remote.

<RemoteContainer> <RemoteController>

GraphQL query and actions that only require the context of a unique repository name to work.

<IssueishSearchesController>

Manages the set of GitHub API issueish searches that we wish to perform, including the special "checked-out pull request" search.

<CurrentPullRequestContainer> <CreatePullRequestTile>

GraphQL query and result rendering for the special "checked-out pull request" search.

<IssueishListController> <IssueishListView>

Render an issueish result as a row within the result list of the current pull request tile.

<IssueishSearchContainer>

GraphQL query and result rendering for an issueish search based on the search() GraphQL connection.

<IssueishListController> <IssueishListView>

Render a list of issueish results as rows within the result list of a specific search.

<ChangedFileItem> <ChangedFileContainer>

The workspace-center pane that appears when looking at the staged or unstaged changes associated with a file.

<MultiFilePatchController> <MultiFilePatchView>

Render a sequence of git-generated file patches within a TextEditor, using decorations to include contextually relevant controls. See MultiFilePatchView atlas below for a more detailed breakdown.

<CommitPreviewItem> <CommitPreviewContainer>

The workspace-center pane item that appears when looking at all the staged changes that will be going into the next commit.

<MultiFilePatchController> <MultiFilePatchView>

<CommitDetailItem> <CommitDetailContainer> <CommitDetailController> <CommitDetailView>

The workspace-center pane item that appears when looking at all the changes associated with a single commit that already exists in the current branch.

<MultiFilePatchController> <MultiFilePatchView>

<IssueishDetailItem> <IssueishDetailContainer> <IssueishDetailController> <IssueDetailView> <PullRequestDetailView>

The workspace-center pane that displays information about a pull request or issue ("issueish", collectively) from github.com.

<IssueTimelineController> <IssueishTimelineView>

Render "timeline events" (comments, label additions or removals, assignments...) related to an issue.

<PrTimelineController> <IssueishTimelineView>

Render "timeline events" related to a pull request.

<PrStatusesView>

Display the current build state of a pull request in detail, including a "donut chart" and links to individual build results.

<PrCommitsView> <PrCommitView>

Enumerate the commits associated with a pull request.

<PullRequestChangedFilesContainer>

Fetch all reviews and comments for a pull request, group comments, and render them. <PullRequestReviewsContainer> <PullRequestReviewCommentsContainer> <PullRequestReviewsController> <PullRequestCommentsView> <PullRequestCommentView>

Show all the changes, separated by files, introduced in a pull request.

<MultiFilePatchController> <MultiFilePatchView>

<InitDialog> <CloneDialog> <OpenIssueishDialog> <CredentialDialog>

Various dialog panels we use to (modally) collect information from users. Notably, the CredentialDialog is used for usernames, passwords, SSH key passwords, and GPG passphrases.

<RepositoryConflictController>

Identifies TextEditors opened on files that git believes contain merge conflicts.

<EditorConflictController>

Parses conflict regions from the buffer associated with a single TextEditor.

<ConflictController>

Creates TextEditor decorations related to one conflict region, including resolution controls.

<StatusBarTileController>

Add the git and GitHub-related tiles to Atom's status bar.

<BranchView>

The little widget that tells you what branch you're on.

<BranchMenuView>

Menu that appears within a tooltip when you click the current branch which lets you switch or create branches.

<PushPullView>

Shows the relative position of your local HEAD to its upstream ("1 ahead", "2 behind"). Allows you to fetch, pull, or push.

<ChangedFilesCountView>

Displays the git logo and the number of changed files. Clicking it opens the git tab.

<GithubTileView>

Displays the GitHub logo. Clicking it opens the GitHub tab.

MultiFilePatchView Atlas

<MultiFilePatchView>

<AtomTextEditor>

React wrapper of an Atom TextEditor. Each MultiFilePatchView contains one AtomTextEditor, regardless of the number of file patch.

<Gutter>

React wrapper of Atom's Gutter class.

<MarkerLayer>

React wrapper of Atom's MarkerLayer class.

<Marker>

React wrapper of Atom's DisplayMarker class.

<Decoration>

React wrapper of Atom's Decoration class.

<FilePatchHeaderView>

Header above each file patch. Handles file patch level operations (e.g. discard change, stage/unstage, jump to file, expand/collapse file patch, etc.)

<HunkHeaderView>

Header above each hunk. Handles more granular stage/unstage operation (per hunk or per line).