Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove FlameFonts from install docs, mark as deprecated #50

Merged
merged 3 commits into from
Nov 22, 2019
Merged

Remove FlameFonts from install docs, mark as deprecated #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b73125
Remove FlameTheme from install docs, mark as deprecated
glambert Nov 22, 2019
04b2c67
Update changelog + deprecation notice
glambert Nov 22, 2019
57e473c
Oops, FlameFonts, not FlameTheme
glambert Nov 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,23 +55,6 @@ Add this `<link>` tag to your `<head>` to load the required fonts:
/>
```

Alternatively, if you use `React Helmet` or can render to the `<head>` tag in JavaScript, you may use the provided `FlameFonts` component:

```jsx
import { Helmet } from 'react-helmet';
import { FlameFonts } from '@lightspeed/flame/Core';

// ..
render() {
return (
<Helmet>
<title>My Title</title>
<FlameFonts />
</Helmet>
);
}
```

### Hook the theme provider, load global styles, and import components

In order to have the proper styling, it is necessary to load the theme object into the application.
Expand Down
6 changes: 6 additions & 0 deletions packages/flame/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Refer to the [CONTRIBUTING guide](https://github.com/lightspeed/flame/blob/master/.github/CONTRIBUTING.md) for more info.

## [Unreleased]

### Deprecated

- FlameFonts component will be removed from the next major version of Flame, use [link](https://github.com/lightspeed/flame#link-fonts) instead ([#50](https://github.com/lightspeed/flame/pull/50))

## 1.2.3 - 2019-11-22

### Fixed
Expand Down
3 changes: 3 additions & 0 deletions packages/flame/src/Core/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,9 @@ const FlameTheme: React.FunctionComponent<FlameThemeProps> = ({
return <ThemeProvider theme={{ ...selectedTheme, ...themeOverrides }}>{children}</ThemeProvider>;
};

// WARNING!
// This component will be deprecated in v2. Instead, use the link tag directly:
// https://github.com/lightspeed/flame#link-fonts
const FlameFonts: React.FunctionComponent = () => (
<link
href="https://fonts.googleapis.com/css?family=Lato:400,700&subset=latin-ext"
Expand Down