seo_renderer 0.4.0

A flutter plugin to render text widgets as html for SEO purpose.

SEO Renderer

A flutter plugin (under development) to render text widgets as html elements for SEO purpose.

Created specifically for issue https://github.com/flutter/flutter/issues/46789 It will automatic detect the crawler using regex and navigator userAgent and add the HtmlElement you choose to the DOM.

All PR's are welcome :)

Getting Started

• Add this to your pubspec.yaml

  dependencies:
    seo_renderer: ^0.4.0
  

• Get the package from Pub:

  flutter packages get
  

• Import it in your file

  import 'package:seo_renderer/seo_renderer.dart';
  

Usage

First we need to add a RouteObserver to automatically remove Html Elements when popped from the Navigation Stack. To do this simply add this line in MaterialApp

navigatorObservers: <RouteObserver<ModalRoute<void>>>[ routeObserver ],

ps : routeObserver is an object, which can be found in utils.dart file.

There are 3 Widgets, TextRenderer, LinkRenderer & ImageRenderer

TextRenderer

TextRenderer Just pass the element new ParagraphElement(), new HeadingElement() or one of other HtmlElement and your Text/RichText Widget.

Paragraph

TextRenderer(
  element: new ParagraphElement(), // This is ParagraphElement by default
  text: Text(
      'Paragraph: Lorem Ipsum is simply dummy text of the printing and typesetting industry.'),
),

Heading

TextRenderer(
  element: new HeadingElement.h1(),
  text: Text(
      'Heading H1: Lorem Ipsum is simply dummy text of the printing and typesetting industry.'),
),

LinkRenderer

Need to pass child : Widget, anchorText : String, link : String

Example :

LinkRenderer(
  anchorText: 'Try Flutter',
  link: 'https://www.flutter.dev',
  child: OutlinedButton(
    onPressed: () {
      launch('https://www.flutter.dev');
    },
    child: Text('Flutter.dev'),
  ),
),

ImageRenderer

Need to pass child : Widget, link : String, alt : String

Example :

ImageRenderer(
  alt: 'Flutter logo',
  link:
      'https://flutter.dev/assets/images/shared/brand/flutter/logo/flutter-lockup.png',
  child: Image.network(
      "https://flutter.dev/assets/images/shared/brand/flutter/logo/flutter-lockup.png"
  ),
),

RendererScrollListener

In case any of your renderer widgets are inside scrollable widgets like SingleChildScrollView, ListView you should wrap it within RendererScrollListener just so renderer widgets can subscribe to scroll changes and reposition themselves if needed.

Example :

RendererScrollListener(
  child: ListView.builder(
    ...
  ),
);

ScreenShot & Example

Live example https://seo-renderer.netlify.app/

Select GoogleBot here's how as userAgent in Network Condition and refresh the page to see created Div Elements.

License

MIT License

Copyright (c) 2021 Sahdeep Singh

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Author & support

This project is created by Sahdeep Singh

If you appreciate my work you can connect and endorse me on LinkedIn to keep me motivated :)