outline icon indicating copy to clipboard operation
outline copied to clipboard

OUTLINE-167: `outline-core-heading`: Heading Component

Open shaal opened this issue 1 year ago • 5 comments

Description

<outline-core-heading>

Summary by CodeRabbit

  • New Features

    • Introduced outline-core-heading component with customizable classes, heading levels, sizes, and weights.
    • Added full card clickability with clickable-card class.
    • New test suite for outline-heading component to ensure proper functionality.
  • Enhancements

    • Updated outline-storybook with new CSS variables for improved design customization.
    • Modified outline-heading stories to reflect new component properties and import paths.
  • Documentation

    • Updated README for outline-core-heading with component summary and properties.
  • Style

    • Added CSS styling rules for text sizes and font weights in outline-core-heading.
    • Introduced new CSS rule for shiny class in outline-extended-button.
  • Refactor

    • Changed import paths and order for better organization and maintainability.
    • Extended OutlineCoreButton to create OutlineExtendedButton with additional variant shiny.

shaal avatar Jun 27 '23 12:06 shaal

⚠️ No Changeset found

Latest commit: 2f08402c45d234056f847ce8536a17dad36fe3c3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Jun 27 '23 12:06 changeset-bot[bot]

Deploy Preview for outlinejs failed.

Name Link
Latest commit 2f08402c45d234056f847ce8536a17dad36fe3c3
Latest deploy log https://app.netlify.com/sites/outlinejs/deploys/65c24416d01d9600088b9283

netlify[bot] avatar Jun 27 '23 12:06 netlify[bot]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/@phase2/[email protected] None +1 453 kB himerus

View full report↗︎

socket-security[bot] avatar Aug 08 '23 13:08 socket-security[bot]

Walkthrough

The overall change introduces a new outline-core-heading component with customizable properties for classes, heading levels, sizes, and weights. It includes updates to CSS for styling, tests for the new component, and storybook configurations. Additionally, there's an outline-extended-button that extends the core button functionality with a new variant. The changes are spread across component definitions, configurations, styles, and documentation updates.

Changes

File Path Change Summary
.../outline-core-heading/README.md Added documentation for outline-core-heading component.
.../outline-core-heading/index.ts Exported OutlineCoreHeading component and related types.
.../outline-core-heading/src/config.ts Updated HeadingSizes and HeadingWeights with specific values and types.
.../outline-core-heading/src/...core-heading.css Added CSS styling rules for text sizes and font weights.
.../outline-core-heading/src/...core-heading.lightdom.css Added CSS classes for text sizes, font weights, and clickable card.
.../outline-core-heading/src/outline-core-heading.ts Introduced OutlineCoreHeading component with properties and methods.
.../outline-core-heading/src/test/...core-heading.test.ts Added test suite for outline-core-heading component.
.../outline-storybook/config/storybook.main.css Reformatted and added new CSS variables.
.../outline-storybook/stories/...heading.stories.ts Updated imports and properties for outline-core-heading stories.
.../outline-templates/default/src/.../outline-extended-button/index.ts Exported OutlineExtendedButton.
.../outline-templates/default/src/.../outline-extended-button/outline-extended-button.css Added new CSS rule for class "shiny".
.../outline-templates/default/src/.../outline-extended-button/outline-extended-button.ts Modified imports, updated button variants, and declared OutlineExtendedButton class.

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot] avatar Dec 05 '23 15:12 coderabbitai[bot]

TODO: @shaal -review and update CSS to be nicer :)

glitchgirl avatar Feb 06 '24 14:02 glitchgirl