Skip to content

Commit

Permalink
chore(doc, snippets): Exposing Mística CSS in readme and snippet fixes (
Browse files Browse the repository at this point in the history
#1252)

I took the opportunity to fix some snippets that was using old props and
fixing some urls that are broken

---------

Co-authored-by: marcoskolodny <[email protected]>
  • Loading branch information
yceballost and marcoskolodny authored Sep 26, 2024
1 parent fe31eca commit b077417
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 79 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Mistica for Web](img/mistica-web-light.svg#gh-light-mode-only)
![Mistica for Web](img/mistica-web-dark.svg#gh-dark-mode-only)

React components library for Telefonica Design System ([Mistica](https://github.com/Telefonica/mistica))
React components library for Telefonica Design System ([Mística](https://github.com/Telefonica/mistica))

![Node.js CI](https://github.com/Telefonica/mistica-web/workflows/Node.js%20CI/badge.svg)

Expand Down Expand Up @@ -85,7 +85,7 @@ that case we recommend to extract it to an external `const` variable outside of
object reference will be the same in every re-render. If for some reason the `theme` must be dynamic in your
app, consider to memoize it (for example, with `React.useMemo` hook).

### Mistica in Next.js app router
### Mística in Next.js app router

If you are using Next.js app router, we highly recommend enabling the following experimental config:

Expand All @@ -103,7 +103,7 @@ read this Next blog post: https://vercel.com/blog/how-we-optimized-package-impor
Explore the components in [Mistica storybook](https://mistica-web.vercel.app)

Start prototyping interfaces with Mistica components in the
[Mistica playroom](https://mistica-web.vercel.app/playroom)
[Mística playroom](https://mistica-web.vercel.app/playroom)

## More docs

Expand All @@ -116,6 +116,7 @@ Start prototyping interfaces with Mistica components in the
- [Fonts](https://github.com/Telefonica/mistica-web/blob/master/doc/fonts.md)
- [Testing notes](https://github.com/Telefonica/mistica-web/blob/master/doc/testing.md)
- [Using Lottie](https://github.com/Telefonica/mistica-web/blob/master/doc/lottie.md)
- [Mística CSS](https://github.com/Telefonica/mistica-web/blob/master/examples/css/README.md)

## Development

Expand All @@ -128,11 +129,11 @@ Start prototyping interfaces with Mistica components in the
- `yarn storybook`: starts storybook
- `yarn playroom`: starts playroom

## More about Mistica
## More about Mística

- [Mistica, the Telefonica Design System](https://github.com/Telefonica/mistica)
- [Mística, the Telefonica Design System](https://github.com/Telefonica/mistica)

### Mistica in other platforms
### Mística in other platforms

- [Android](https://github.com/Telefonica/mistica-android)
- [iOS](https://github.com/Telefonica/mistica-ios)
Expand All @@ -141,10 +142,10 @@ Start prototyping interfaces with Mistica components in the

See [CONTRIBUTING.md](https://github.com/Telefonica/mistica-web/blob/master/CONTRIBUTING.md)

### Mistica Community
### Mística Community

About [Mistica Community](https://mistica-web.vercel.app/?path=/story/community-welcome--default)
About [Mística Community](https://mistica-web.vercel.app/?path=/story/community-welcome--default)

If you are building a Mistica Community component, place it inside the
If you are building a Mística Community component, place it inside the
[`src/community` folder](src/community/) and don't forget to export it in the
[`src/community/index.ts`](src/community/index.tsx) file to make it public.
6 changes: 3 additions & 3 deletions examples/css/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Mistica css
# Mística CSS

If you can't use the Mistica React components in your project, you can still use the Mistica css to style your
If you can't use the Mística React components in your project, you can still use the Mística CSS to style your
app.

Mistica css is a set of stylesheets that you can use to style your app with the design tokens of the system.
Mística CSS is a set of stylesheets that you can use to style your app with the design tokens of the system.
It includes css custom properties (css variables) for colors, border radius, typography, etc.

## How to use
Expand Down
Loading

1 comment on commit b077417

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploy preview for mistica-web ready!

✅ Preview
https://mistica-5j8tktdoh-flows-projects-65bb050e.vercel.app

Built with commit b077417.
This pull request is being automatically deployed with vercel-action

Please sign in to comment.